Skip to main content

MemoryConfig

Struct MemoryConfig 

Source
pub struct MemoryConfig {
    pub topic: String,
    pub url: Option<String>,
    pub capacity: Option<usize>,
    pub request_reply: bool,
    pub request_timeout_ms: Option<u64>,
    pub subscribe_mode: bool,
    pub enable_nack: bool,
    pub enable_nack_overridden: bool,
}

Fields§

§topic: String

The topic name or transport URL. Can be:

  • Simple name: “my-topic” (defaults to memory://my-topic)
  • Memory URL: “memory://my-topic”
  • IPC URL: “ipc://my-queue” or “ipc:///path/to/socket”
  • Unix socket: “unix:///path/to/socket” (Unix only)
  • Named pipe: “pipe://my-pipe” (Windows only)

Either topic or url can be specified (they are serde aliases).

§url: Option<String>

Transport URL (serde alias for topic). Use either topic or url.

§capacity: Option<usize>

The capacity of the channel. Defaults to 100.

§request_reply: bool

(Publisher only) If true, send() waits for a response.

§request_timeout_ms: Option<u64>

(Publisher only) Timeout for request-reply operations in milliseconds. Defaults to 30000ms.

§subscribe_mode: bool

(Consumer only) If true, act as a Subscriber (fan-out). Defaults to false (queue).

§enable_nack: bool

(Consumer only) If true, enables NACK support (re-queuing), which requires cloning messages. Defaults to false for memory:// transports, automatically true for IPC transports (ipc://, unix://, pipe://).

§enable_nack_overridden: bool

Implementations§

Source§

impl MemoryConfig

Source

pub fn new(topic: impl Into<String>, capacity: Option<usize>) -> Self

Source

pub fn new_with_url(url: impl Into<String>, capacity: Option<usize>) -> Self

Source

pub fn with_subscribe(self, subscribe_mode: bool) -> Self

Source

pub fn with_request_reply(self, request_reply: bool) -> Self

Source

pub fn get_transport_identifier(&self) -> Result<String>

Gets the effective transport identifier. If topic contains ://, it’s treated as a URL, otherwise as memory://topic.

Source

pub fn is_ipc_transport(&self) -> bool

Check if the transport URL scheme suggests IPC (inter-process communication). IPC transports should enable nack by default for reliability.

Source

pub fn with_smart_defaults(self) -> Self

Apply smart defaults based on the transport type. For IPC transports, enable_nack defaults to true for reliability.

Trait Implementations§

Source§

impl Clone for MemoryConfig

Source§

fn clone(&self) -> MemoryConfig

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 Debug for MemoryConfig

Source§

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

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

impl Default for MemoryConfig

Source§

fn default() -> MemoryConfig

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

impl<'de> Deserialize<'de> for MemoryConfig

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 Serialize for MemoryConfig

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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