Struct SchemaRegistryClient 

pub struct SchemaRegistryClient { /* private fields */ }

Async client for the Confluent Schema Registry REST API.

Provides schema lookup by ID and subject, caching with LRU eviction and TTL, compatibility checking, and Avro-to-Arrow schema conversion.

Implementations

impl SchemaRegistryClient

pub fn new(base_url: impl Into<String>, auth: Option<SrAuth>) -> Self

Creates a new Schema Registry client with default cache config.

pub fn with_tls( base_url: impl Into<String>, auth: Option<SrAuth>, ca_cert_path: &str, ) -> Result<Self, ConnectorError>

Creates a TLS client (CA cert only). Delegates to Self::with_tls_mtls.

Errors

Returns ConnectorError::ConfigurationError if the CA cert cannot be read.

pub fn with_tls_mtls( base_url: impl Into<String>, auth: Option<SrAuth>, ca_cert_path: &str, client_cert_path: Option<&str>, client_key_path: Option<&str>, ) -> Result<Self, ConnectorError>

Creates a client with full TLS/mTLS support.

Errors

Returns ConnectorError::ConfigurationError if any cert/key file cannot be read or parsed.

pub fn with_cache_config( base_url: impl Into<String>, auth: Option<SrAuth>, cache_config: SchemaRegistryCacheConfig, ) -> Self

Creates a new Schema Registry client with custom cache config.

pub fn base_url(&self) -> &str

Returns the base URL of the Schema Registry.

pub fn has_auth(&self) -> bool

Returns true if authentication is configured.

pub fn cache_config(&self) -> &SchemaRegistryCacheConfig

Returns the cache configuration.

pub async fn get_schema_by_id( &self, id: i32, ) -> Result<CachedSchema, ConnectorError>

Fetches a schema by its global ID.

Results are cached for subsequent lookups.

Errors

Returns ConnectorError if the HTTP request fails or the schema cannot be parsed.

pub async fn get_latest_schema( &self, subject: &str, ) -> Result<CachedSchema, ConnectorError>

Fetches the latest schema version for a subject.

Errors

Returns ConnectorError if the HTTP request fails.

pub async fn get_schema_version( &self, subject: &str, version: i32, ) -> Result<CachedSchema, ConnectorError>

Fetches a specific schema version for a subject.

Errors

Returns ConnectorError if the HTTP request fails.

pub async fn check_compatibility( &self, subject: &str, schema_str: &str, ) -> Result<CompatibilityResult, ConnectorError>

Checks compatibility of a schema against the latest version.

Errors

Returns ConnectorError if the HTTP request fails.

pub async fn get_compatibility_level( &self, subject: &str, ) -> Result<CompatibilityLevel, ConnectorError>

Gets the compatibility level for a subject.

Errors

Returns ConnectorError if the HTTP request fails.

pub async fn set_compatibility_level( &self, subject: &str, level: CompatibilityLevel, ) -> Result<(), ConnectorError>

Sets the compatibility level for a subject.

Errors

Returns ConnectorError if the HTTP request fails.

pub async fn resolve_confluent_id( &self, id: i32, ) -> Result<CachedSchema, ConnectorError>

Resolves a Confluent schema ID, returning from cache if available.

This is the hot-path method called during Avro deserialization to look up schemas by the 4-byte ID in the Confluent wire format.

Errors

Returns ConnectorError if the schema cannot be fetched.

pub async fn register_schema( &self, subject: &str, schema_str: &str, schema_type: SchemaType, ) -> Result<i32, ConnectorError>

Registers a schema with the Schema Registry under the given subject.

Returns the schema ID assigned by the registry. Caches the result so subsequent calls with the same subject return immediately.

Errors

Returns ConnectorError if the HTTP request fails or the response is malformed.

pub async fn validate_and_register_schema( &self, subject: &str, schema_str: &str, schema_type: SchemaType, ) -> Result<i32, ConnectorError>

Validates compatibility and registers a schema in one step.

If the subject already has schemas registered, checks compatibility first. Returns SerdeError::SchemaIncompatible if the new schema is not compatible with the existing versions.

Errors

Returns ConnectorError::Serde(SchemaIncompatible) if incompatible, or ConnectorError for HTTP/network errors.

pub fn is_cached(&self, id: i32) -> bool

Returns true if the schema ID is in the local cache.

pub fn cache_size(&self) -> usize

Returns the number of cached schemas.

Trait Implementations

impl Debug for SchemaRegistryClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.