gravel_ffi/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
//! This is the interface library between the main gravel application and individual plugins.
//!
//! [`abi_stable`] is used to facilitate safe FFI across compiler versions.

// the abi_stable derives/macros generate code that doesn't gel with these lints
// since you can't just slap these on generated code they're disabled for the whole crate
#![allow(
	clippy::empty_docs,
	clippy::needless_lifetimes,
	clippy::used_underscore_binding,
	non_local_definitions,
	single_use_lifetimes,
	unused_qualifications
)]

mod cache;
#[doc(hidden)]
pub mod config;
mod frontend;
mod hit;
pub mod logging;
pub mod paths;
mod plugin;
mod prefix;
mod provider;

/// This module re-exports the types needed to write plugins.
///
/// Bring them all into scope with `use gravel_ffi::prelude::*;`.  
/// <sub>may not actually contain *all* types required; terms and conditions apply</sub>
pub mod prelude {
	pub use crate::{
		gravel_frontend, gravel_provider, ActionKind, ArcDynHit, BoxDynFrontendContext, Frontend, FrontendContext,
		FrontendContextExt, FrontendExitStatus, FrontendMessage, FrontendMessageNe, Hit, HitCache, PluginConfigAdapter,
		Provider, ProviderResult, QueryResult, RefDynHitActionContext, ScoredHit, SimpleHit, StaticHitCache, MAX_SCORE,
		MIN_SCORE,
	};

	pub use abi_stable::external_types::crossbeam_channel::RReceiver;
	pub use abi_stable::std_types::{ROption, RStr};
	pub use abi_stable::traits::{IntoReprC, IntoReprRust};
}

pub use cache::{HitCache, StaticHitCache};
pub use config::PluginConfigAdapter;
pub use frontend::{
	BoxDynFrontend, BoxDynFrontendContext, Frontend, FrontendContext, FrontendContextExt, FrontendExitStatus,
	FrontendExitStatusNe, FrontendInner, FrontendMessage, FrontendMessageNe, QueryResult,
};
pub use hit::{
	clone_hit_arc, ActionKind, ArcDynHit, Hit, HitActionContext, RefDynHitActionContext, ScoredHit, SimpleHit,
	MAX_SCORE, MIN_SCORE,
};
pub use plugin::{PluginDefinition, PluginMetadata};
pub use prefix::{PluginLib, PluginLibRef};
pub use provider::{BoxDynProvider, Provider, ProviderInner, ProviderResult};

pub use gravel_ffi_macros::*;

#[cfg(test)]
mod clippy_shut_up {
	// this has to be put *somewhere* so clippy doesn't complain that the crate is unused
	// (even though it's used in the integration tests)
	use gravel_core as _;
	use gravel_test_utils as _;
}