Skip to main content

ServerInfo

Struct ServerInfo 

Source
pub struct ServerInfo {
Show 20 fields pub version: String, pub supported_protocol_versions: Vec<String>, pub server_time: SystemTime, pub restricts_encodings: bool, pub allowed_encodings: Vec<String>, pub max_payload_bytes: u64, pub max_custom_entries: u32, pub max_custom_total_bytes: u64, pub max_custom_key_bytes: u32, pub max_queue_name_bytes: u32, pub max_job_type_bytes: u32, pub max_idempotency_key_bytes: u32, pub max_schedule_horizon: Duration, pub max_enqueue_batch: u32, pub max_reserve_batch: u32, pub max_reserve_queues: u32, pub max_wait_timeout: Duration, pub max_lease_duration: Duration, pub strict_queues: bool, pub dead_letter_retention_enabled: bool,
}
Expand description

The server’s version, capabilities, and limits, as returned by get_server_info.

The various max_* fields mirror the limits behind the JobRejection variants. Fetching this once at startup lets a producer validate jobs locally and avoid round-trips that would only be rejected. The limits are the server’s defaults; an individual queue may be configured more or less strictly.

Fields§

§version: String

Server version (a semver string).

§supported_protocol_versions: Vec<String>

Protocol versions the server supports.

§server_time: SystemTime

The server’s current wall-clock time, useful for detecting clock skew.

§restricts_encodings: bool

If true, only encodings in allowed_encodings are accepted; if false, any encoding is accepted.

§allowed_encodings: Vec<String>

The accepted encodings when restricts_encodings is set.

§max_payload_bytes: u64

Maximum payload size in bytes (→ JobRejection::PayloadTooLarge).

§max_custom_entries: u32

Maximum entries in the custom map (→ JobRejection::CustomEntriesTooMany).

§max_custom_total_bytes: u64

Maximum total bytes across the custom map (→ JobRejection::CustomMapTooLarge).

§max_custom_key_bytes: u32

Maximum bytes in a single custom key (→ JobRejection::CustomKeyTooLong).

§max_queue_name_bytes: u32

Maximum bytes in a queue name (→ JobRejection::QueueNameTooLong).

§max_job_type_bytes: u32

Maximum bytes in a job type (→ JobRejection::JobTypeNameTooLong).

§max_idempotency_key_bytes: u32

Maximum bytes in an idempotency key (→ JobRejection::IdempotencyKeyTooLong).

§max_schedule_horizon: Duration

How far ahead a job may be scheduled (→ JobRejection::ScheduledTooFar).

§max_enqueue_batch: u32

Maximum jobs in one enqueue batch; larger batches fail the whole request.

§max_reserve_batch: u32

Maximum jobs returned by one reserve; larger requests are clamped, not rejected.

§max_reserve_queues: u32

Maximum queues one reserve may list; exceeding this is an error.

§max_wait_timeout: Duration

Maximum long-poll wait; larger requests are clamped.

§max_lease_duration: Duration

Maximum lease duration; larger requests are clamped.

§strict_queues: bool

If true, enqueueing to an undeclared queue is rejected with JobRejection::UnknownQueue; if false, queues are created on demand.

§dead_letter_retention_enabled: bool

If true, the server retains dead-lettered jobs and drain_dead_letters can return them; if false, dead jobs are deleted and drain always returns empty.

Trait Implementations§

Source§

impl Clone for ServerInfo

Source§

fn clone(&self) -> ServerInfo

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 ServerInfo

Source§

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

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

impl PartialEq for ServerInfo

Source§

fn eq(&self, other: &ServerInfo) -> 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 ServerInfo

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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