Skip to main content

SchemaCachePolicy

Enum SchemaCachePolicy 

Source
#[non_exhaustive]
pub enum SchemaCachePolicy { Disabled, Cached { capacity: NonZeroUsize, subject_ttl: Option<Duration>, }, }
Expand description

How the default cache ages and bounds what it holds.

The two halves of the registry’s answer expire differently, and that is not a preference but a property of the service: a schema id is immutable. The registry assigns an id per distinct schema definition, by content - registering a new version of a subject mints a new id and leaves the old one resolving to the old schema for ever, and registering an identical schema under a different subject hands back the id it already had. A subject’s latest version, by contrast, moves whenever someone registers one.

“Per registry” is really per schema context: a registry can carry several, and each numbers its ids from one, so the same id means different schemas in two of them. This was checked against a live registry - the same schema registered in the default context and in a named one both came back as id 1. It bounds what this cache is: keyed by id, it is correct for a client that stays inside one context, which is what a client addressing plain subject names does. An app that reaches across contexts through one client, by writing :.context:subject subject names, needs a client per context rather than one cache spanning them.

So an id-keyed entry can never go stale and needs no expiry - a TTL over it could only cause a refetch that returns the identical bytes - while a subject-keyed entry can, and is the only thing the subject_ttl of Cached governs. Confluent’s own clients scope their latest.cache.ttl.sec to exactly the latest-version caches for the same reason.

What ids still need is a bound. A consumer meets one id per writer version it is sent, which is small in a healthy topology and unbounded in a broken one (a producer registering a schema per message), so the cache is capped and evicts in insertion order. Evicting an id that is still in use costs one refetch and never a wrong answer, which is what makes plain insertion order enough here and a recency policy not worth its bookkeeping.

§Examples

A producer that notices a newly registered version of a subject within five minutes, without a restart:

use std::time::Duration;

use ruststream_rdkafka::prelude::*;
use ruststream_rdkafka::{SchemaCachePolicy, SchemaFrame, SchemaRegistry};

fn app() -> impl App {
    let registry = SchemaRegistry::new("http://localhost:8081").cache_policy(
        SchemaCachePolicy::Cached {
            capacity: nonzero!(256usize),
            subject_ttl: Some(Duration::from_secs(300)),
        },
    );
    RustStream::new(AppInfo::new("orders", "0.1.0"))
        .publish_layer(SchemaFrame::new(registry))
        .with_broker(
            KafkaBroker::new(["localhost:9092"]).default_group("orders-svc"),
            |b| {
                b.include(confirm);
            },
        )
}

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Disabled

Nothing is remembered: every lookup reaches the registry.

This is a real configuration, not a zero TTL wearing a disguise - for a process that must hold no schema state, or a test that wants every call observable. It has one consequence worth knowing before choosing it: a synchronous codec reads the cache and cannot await a miss, so AvroCodec::registry and SchemaFramed cannot work under it. The transcoding path, whose lookups are all async, works unchanged.

§

Cached

Ids are remembered up to capacity, and a subject’s resolved version for subject_ttl.

Fields

§capacity: NonZeroUsize

The most id-keyed schemas held at once; the oldest is dropped past it.

§subject_ttl: Option<Duration>

How long a subject’s resolved version is trusted before the next async lookup re-resolves it. None never re-resolves, which is Confluent’s own default.

This governs the async lookups only (warm and the publish-side transcode). A codec’s subject is resolved once, when the broker connects, and stays put: its encode is synchronous and cannot re-resolve, and a producer changing the schema it writes mid-process is a deliberate act, not something to absorb silently between two messages.

Trait Implementations§

Source§

impl Clone for SchemaCachePolicy

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for SchemaCachePolicy

Source§

impl Debug for SchemaCachePolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SchemaCachePolicy

Source§

fn default() -> Self

Ids kept up to 1000 (Confluent’s own default bound), subjects never re-resolved (Confluent’s own default TTL).

Source§

impl Eq for SchemaCachePolicy

Source§

impl PartialEq for SchemaCachePolicy

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SchemaCachePolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> PublishedThrough<DefaultSlot> for T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more