Struct async_nats::jetstream::stream::Config

source ·
pub struct Config {
Show 32 fields pub name: String, pub max_bytes: i64, pub max_messages: i64, pub max_messages_per_subject: i64, pub discard: DiscardPolicy, pub discard_new_per_subject: bool, pub subjects: Vec<String>, pub retention: RetentionPolicy, pub max_consumers: i32, pub max_age: Duration, pub max_message_size: i32, pub storage: StorageType, pub num_replicas: usize, pub no_ack: bool, pub duplicate_window: Duration, pub template_owner: String, pub sealed: bool, pub description: Option<String>, pub allow_rollup: bool, pub deny_delete: bool, pub deny_purge: bool, pub republish: Option<Republish>, pub allow_direct: bool, pub mirror_direct: bool, pub mirror: Option<Source>, pub sources: Option<Vec<Source>>, pub metadata: HashMap<String, String>, pub subject_transform: Option<SubjectTransform>, pub compression: Option<Compression>, pub consumer_limits: Option<ConsumerLimits>, pub first_sequence: Option<u64>, pub placement: Option<Placement>,
}
Expand description

StreamConfig determines the properties for a stream. There are sensible defaults for most. If no subjects are given the name will be used as the only subject.

Fields§

§name: String

A name for the Stream. Must not have spaces, tabs or period . characters

§max_bytes: i64

How large the Stream may become in total bytes before the configured discard policy kicks in

§max_messages: i64

How large the Stream may become in total messages before the configured discard policy kicks in

§max_messages_per_subject: i64

Maximum amount of messages to keep per subject

§discard: DiscardPolicy

When a Stream has reached its configured max_bytes or max_msgs, this policy kicks in. DiscardPolicy::New refuses new messages or DiscardPolicy::Old (default) deletes old messages to make space

§discard_new_per_subject: bool

Prevents a message from being added to a stream if the max_msgs_per_subject limit for the subject has been reached

§subjects: Vec<String>

Which NATS subjects to populate this stream with. Supports wildcards. Defaults to just the configured stream name.

§retention: RetentionPolicy

How message retention is considered, Limits (default), Interest or WorkQueue

§max_consumers: i32

How many Consumers can be defined for a given Stream, -1 for unlimited

§max_age: Duration

Maximum age of any message in the stream, expressed in nanoseconds

§max_message_size: i32

The largest message that will be accepted by the Stream

§storage: StorageType

The type of storage backend, File (default) and Memory

§num_replicas: usize

How many replicas to keep for each message in a clustered JetStream, maximum 5

§no_ack: bool

Disables acknowledging messages that are received by the Stream

§duplicate_window: Duration

The window within which to track duplicate messages.

§template_owner: String

The owner of the template associated with this stream.

§sealed: bool

Indicates the stream is sealed and cannot be modified in any way

§description: Option<String>

A short description of the purpose of this stream.

§allow_rollup: bool

Indicates if rollups will be allowed or not.

§deny_delete: bool

Indicates deletes will be denied or not.

§deny_purge: bool

Indicates if purges will be denied or not.

§republish: Option<Republish>

Optional republish config.

§allow_direct: bool

Enables direct get, which would get messages from non-leader.

§mirror_direct: bool

Enable direct access also for mirrors.

§mirror: Option<Source>

Stream mirror configuration.

§sources: Option<Vec<Source>>

Sources configuration.

§metadata: HashMap<String, String>

Additional stream metadata.

§subject_transform: Option<SubjectTransform>

Allow applying a subject transform to incoming messages

§compression: Option<Compression>

Override compression config for this stream. Wrapping enum that has None type with Option is there because Stream can override global compression set to Compression::S2 to Compression::None, which is different from not overriding global config with anything.

§consumer_limits: Option<ConsumerLimits>

Set limits on consumers that are created on this stream.

§first_sequence: Option<u64>

Sets the first sequence for the stream.

§placement: Option<Placement>

Placement configuration for clusters and tags.

Trait Implementations§

source§

impl Clone for Config

source§

fn clone(&self) -> Config

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Config

source§

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

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

impl Default for Config

source§

fn default() -> Config

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Config

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<&Config> for Config

source§

fn from(sc: &Config) -> Config

Converts to this type from the input type.
source§

impl From<&str> for Config

source§

fn from(s: &str) -> Config

Converts to this type from the input type.
source§

impl PartialEq for Config

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Config

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Config

source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,