Skip to main content

Crate conduit_rs

Crate conduit_rs 

Source
Expand description

Official Rust SDK for the Conduit API.

Conduit exposes four stable resource groups:

The primary production path is webhook-first: create a report or matching job, persist the returned receipt, then react to a verified webhook when the job reaches a terminal state. ReportHandle and MatchingHandle provide polling helpers for scripts and local tools.

Re-exports§

pub use matching::MatchingContext;
pub use matching::MatchingCreate;
pub use matching::MatchingHandle;
pub use matching::MatchingReceipt;
pub use matching::MatchingResource;
pub use matching::SubjectRef;
pub use model::CreditReservationStatus;
pub use model::Entity;
pub use model::FileDeleteReceipt;
pub use model::Job;
pub use model::JobCreditReservation;
pub use model::JobErrorData;
pub use model::JobEvent;
pub use model::JobEventKind;
pub use model::JobKind;
pub use model::JobStage;
pub use model::JobStatus;
pub use model::ListEntitiesResponse;
pub use model::ListFilesResponse;
pub use model::Matching;
pub use model::MatchingOutputData;
pub use model::MatchingResolvedSubject;
pub use model::MediaFile;
pub use model::MediaObject;
pub use model::MediaRetention;
pub use model::ReceiptStatus;
pub use model::Report;
pub use model::ReportOutputData;
pub use model::RetentionLockResult;
pub use model::Usage;
pub use primitives::ActionOptions;
pub use primitives::EntitiesResource;
pub use primitives::JobsResource;
pub use primitives::MediaResource;
pub use primitives::PrimitivesResource;
pub use primitives::Source;
pub use primitives::StreamOptions;
pub use primitives::WaitOptions;
pub use reports::OnMiss;
pub use reports::ReportCreate;
pub use reports::ReportHandle;
pub use reports::ReportReceipt;
pub use reports::ReportTemplate;
pub use reports::ReportsResource;
pub use reports::Target;
pub use reports::WebhookEndpoint;
pub use webhooks::MatchingCompletedEvent;
pub use webhooks::MatchingFailedEvent;
pub use webhooks::ReportCompletedEvent;
pub use webhooks::ReportFailedEvent;
pub use webhooks::UnknownWebhookEvent;
pub use webhooks::WebhookEvent;
pub use webhooks::WebhookFailure;
pub use webhooks::WebhooksResource;

Modules§

matching
Matching workflow types and resource methods. Matching workflow types and resource methods.
model
Typed response models returned by the SDK. Typed response models returned by the Conduit API.
primitives
Advanced low-level media, jobs, and entities resources. Advanced primitives for media, jobs, and entities.
reports
Report workflow types and resource methods. Report workflow types and resource methods.
webhooks
Webhook verification and typed event parsing. Webhook verification and typed event parsing.

Structs§

Conduit
Top-level API client. Main entry point for the Conduit API.
ConduitBuilder
Top-level API client. Builder used to configure and construct a Conduit client.

Enums§

Error
Shared SDK error type and result alias. Typed error returned by all public SDK operations.

Constants§

DEFAULT_MAX_SOURCE_BYTES
Top-level API client. Default maximum source size, in bytes, accepted by SDK-managed uploads.

Type Aliases§

Result
Shared SDK error type and result alias. Result alias used by the Conduit Rust SDK.