Struct AcquireSemaphore

pub struct AcquireSemaphore {
    pub req_id: u64,
    pub name: String,
    pub timeout_millis: u64,
    pub count: u64,
    pub data: Vec<u8>,
    pub ephemeral: bool,
}

Used to acquire a semaphore

WARNING: a single session cannot acquire the same semaphore multiple times

Later requests override previous operations with the same semaphore, e.g. to reduce acquired count, change timeout or attached data.

Fields

req_id: u64

Client-defined request id, echoed in the response

name: String

Name of the semaphore to acquire

timeout_millis: u64

Timeout in milliseconds after which operation will fail if it’s still waiting in the waiters queue

count: u64

Number of tokens to acquire on the semaphore

data: Vec<u8>

User-defined binary data that may be attached to the operation

ephemeral: bool

Ephemeral semaphores are created with the first acquire operation and automatically deleted with the last release operation

Trait Implementations

impl Clone for AcquireSemaphore

fn clone(&self) -> AcquireSemaphore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AcquireSemaphore

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

Formats the value using the given formatter.

impl Default for AcquireSemaphore

fn default() -> AcquireSemaphore

Returns the “default value” for a type.

impl Message for AcquireSemaphore

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for AcquireSemaphore

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AcquireSemaphore