Struct KeyRequestMessage

#[repr(transparent)]
pub struct KeyRequestMessage {
    pub key: Option<SecretKey>,
}

Available on crate feature encryption only.

KeyRequest is used to contain input parameters which get broadcasted to all nodes as part of a key query operation.

Fields

key: Option<SecretKey>

The secret key

Implementations

impl KeyRequestMessage

pub const fn key(&self) -> &Option<SecretKey>

Returns the secret key

pub const fn with_key(self, val: Option<SecretKey>) -> Self

Sets the secret key (Builder pattern)

Trait Implementations

impl<I, A> AsMessageRef<I, A> for &KeyRequestMessage

fn as_message_ref(&self) -> SerfMessageRef<'_, I, A>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyRequestMessage

fn clone(&self) -> KeyRequestMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyRequestMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyRequestMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyRequestMessage

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transformable for KeyRequestMessage

type Error = OptionSecretKeyTransformError

The error type returned when encoding or decoding fails.

fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error>

Encodes the value into the given buffer for transmission.

fn encoded_len(&self) -> usize

Returns the encoded length of the value. This is used to pre-allocate a buffer for encoding.

fn encode_to_writer<W: Write>(&self, writer: &mut W) -> Result<usize>

Encodes the value into the given writer for transmission.

async fn encode_to_async_writer<W: AsyncWrite + Send + Unpin>( &self, writer: &mut W, ) -> Result<usize>

Encodes the value into the given async writer for transmission.

fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>

where Self: Sized,

Decodes the value from the given buffer received over the wire.

fn decode_from_reader<R: Read>(reader: &mut R) -> Result<(usize, Self)>

where Self: Sized,

Decodes the value from the given reader received over the wire.

async fn decode_from_async_reader<R: AsyncRead + Send + Unpin>( reader: &mut R, ) -> Result<(usize, Self)>

where Self: Sized,

Decodes the value from the given async reader received over the wire.

fn encode_to_vec(&self) -> Result<Vec<u8>, Self::Error>

Encodes the value into a vec for transmission.

impl Copy for KeyRequestMessage

impl Eq for KeyRequestMessage

impl StructuralPartialEq for KeyRequestMessage