bookclerk_plugin_abi::kind
Output-plugin configuration DTOs carried as application/json inside
crate::ExtensibleConfig (Bindings.config for the storage entrypoint).
Field names serialize as camelCase on the wire. Every method payload
is a typed Cap'n Proto struct generated into crate::generated; only the
operator-configured destination knobs remain JSON because they are
plugin-private configuration, not ABI method parameters.
| Item | Kind | Summary |
|---|---|---|
S3CredentialsDto |
struct | Static AWS-style credentials injected by the host (never read from guest env). |
OutputS3ContextDto |
struct | S3 destination knobs the host grants through Bindings.config. |
OutputLocalContextDto |
struct | Local filesystem destination knobs the host grants through Bindings.config. |
pub struct S3CredentialsDto {
pub access_key_id: String,
pub secret_access_key: String,
pub session_token: Option<String>,
}
Static AWS-style credentials injected by the host (never read from guest env).
Debug redacts secret fields. Present on OutputS3ContextDto when the
host has resolved keys from env or encrypted_secrets.
Fields
access_key_id: Access key id (wireaccessKeyId).secret_access_key: Secret access key (wiresecretAccessKey).session_token: Optional session token for temporary credentials (wiresessionToken).
Implements: Clone, Debug, Deserialize<'de>, Eq, PartialEq, Serialize
pub struct OutputS3ContextDto {
pub plugin_data_dir: String,
pub bucket: String,
pub prefix: String,
pub region: String,
pub endpoint: Option<String>,
pub force_path_style: bool,
pub notification_queue_url: Option<String>,
pub credentials: Option<S3CredentialsDto>,
}
S3 destination knobs the host grants through Bindings.config.
Fields
plugin_data_dir: Scoped writable directory for this plugin only (…/plugin-state/<PluginKey fs-id>/data, wirepluginDataDir). Empty on the logical ABI (jail layout is transport-private).bucket: Target bucket name.prefix: Key prefix under the bucket ([output.s3].prefix).region: AWS region (or compatible).endpoint: Optional custom endpoint (MinIO / path-style hosts); host may prependhttps://for bare hostnames.force_path_style: When true, force path-style addressing (wireforcePathStyle).notification_queue_url: Amazon SQS queue URL the bucket sends its object events to (wirenotificationQueueUrl); when set the guest serveschangesfrom it. Absent means no change feed.credentials: When absent the guest may use the AWS SDK default provider chain (unconfined dev only).
Implements: Clone, Debug, Deserialize<'de>, Eq, PartialEq, Serialize
pub struct OutputLocalContextDto {
pub plugin_data_dir: String,
pub root: String,
pub prefix: String,
}
Local filesystem destination knobs the host grants through
Bindings.config.
Fields
plugin_data_dir: Scoped writable directory for this plugin only (…/plugin-state/<PluginKey fs-id>/data, wirepluginDataDir). Empty on the logical ABI (jail layout is transport-private).root: Library output root ([output.local].root). Empty on the logical ABI; native guests readBOOKCLERK_OUTPUT_LOCAL_ROOTinstead.prefix: Key prefix underroot([output.local].prefix).
Implements: Clone, Debug, Deserialize<'de>, Eq, PartialEq, Serialize
Generated from crates/bookclerk-plugin-abi at main · View as Markdown