Module prelude

Module prelude 

Source
Expand description

This module re-exports the types needed to write plugins.

Bring them all into scope with use gravel_ffi::prelude::*;.
may not actually contain all types required; terms and conditions apply

Re-exports§

pub use crate::ActionKind;
pub use crate::ArcDynHit;
pub use crate::BoxDynFrontendContext;
pub use crate::Frontend;
pub use crate::FrontendContext;
pub use crate::FrontendContextExt;
pub use crate::FrontendExitStatus;
pub use crate::FrontendMessage;
pub use crate::FrontendMessageNe;
pub use crate::Hit;
pub use crate::HitCache;
pub use crate::MAX_SCORE;
pub use crate::MIN_SCORE;
pub use crate::PluginConfigAdapter;
pub use crate::Provider;
pub use crate::ProviderResult;
pub use crate::QueryResult;
pub use crate::RefDynHitActionContext;
pub use crate::ScoredHit;
pub use crate::SimpleHit;
pub use crate::StaticHitCache;

Structs§

RReceiver
The receiver end of a channel, which can be either bounded or unbounded.
RStr
Ffi-safe equivalent of &'a str

Enums§

ROption
Ffi-safe equivalent of the std::option::Option type.

Traits§

IntoReprC
Converts a #[repr(Rust)] type into its #[repr(C)] equivalent.
IntoReprRust
Converts a #[repr(C)] type into its #[repr(Rust)] equivalent.

Attribute Macros§

gravel_frontend
Automatically implements the necessary FFI-glue for plugins to work.
gravel_provider
Automatically implements the necessary FFI-glue for plugins to work.