Struct EnvelopeRequest

#[non_exhaustive]
pub struct EnvelopeRequest {
    pub request_data: Bytes,
    pub request_principal: Option<Bytes>,
    pub client_host_address: Bytes,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

request_data: Bytes

The embedded request header and data.

Supported API versions: 0

request_principal: Option<Bytes>

Value of the initial client principal when the request is redirected by a broker.

Supported API versions: 0

client_host_address: Bytes

The original client’s address in bytes.

Supported API versions: 0

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl EnvelopeRequest

pub fn with_request_data(self, value: Bytes) -> Self

Sets request_data to the passed value.

The embedded request header and data.

Supported API versions: 0

pub fn with_request_principal(self, value: Option<Bytes>) -> Self

Sets request_principal to the passed value.

Value of the initial client principal when the request is redirected by a broker.

Supported API versions: 0

pub fn with_client_host_address(self, value: Bytes) -> Self

Sets client_host_address to the passed value.

The original client’s address in bytes.

Supported API versions: 0

pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self

Sets unknown_tagged_fields to the passed value.

pub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self

Inserts an entry into unknown_tagged_fields.

Trait Implementations

impl Clone for EnvelopeRequest

fn clone(&self) -> EnvelopeRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeRequest

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

Formats the value using the given formatter.

impl Decodable for EnvelopeRequest

Available on crate feature broker only.

fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self>

Decode the message from the provided buffer and version.

impl Default for EnvelopeRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for EnvelopeRequest

Available on crate feature client only.

fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()>

Encode the message into the target buffer.

fn compute_size(&self, version: i16) -> Result<usize>

Compute the total size of the message when encoded.

impl From<EnvelopeRequest> for RequestKind

Available on crate feature messages_enums only.

fn from(value: EnvelopeRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for EnvelopeRequest

fn header_version(version: i16) -> i16

Maps a header version to a given version for a particular API message.

impl Message for EnvelopeRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for EnvelopeRequest

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

Available on crate features client and broker only.

const KEY: i16 = 58i16

The API key of this request.

type Response = EnvelopeResponse

The response associated with this request.

impl StructuralPartialEq for EnvelopeRequest