Struct Instruction

pub struct Instruction {
    pub kind: Option<Kind>,
}

Communication structure used by gistit-ipc crate

Fields

kind: Option<Kind>

Implementations

impl Instruction

pub const fn request_status() -> Self

pub const fn request_fetch(hash: String) -> Self

pub const fn request_provide(gistit: Gistit) -> Self

pub const fn request_shutdown() -> Self

pub const fn request_dial(address: String) -> Self

pub const fn respond_status( peer_id: String, peer_count: u32, pending_connections: u32, hosting: u32, ) -> Self

pub const fn respond_fetch(gistit: Option<Gistit>) -> Self

pub const fn respond_provide(maybe_hash: Option<String>) -> Self

pub fn expect_request(self) -> Result<Kind>

Unwraps Self expecting a request kind

Errors

Fails if instruction is not a request or is none

pub fn expect_response(self) -> Result<Kind>

Unwraps Self expecting a response kind

Errors

Fails if instruction is not a response or is none

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl Default for Instruction

fn default() -> Self

Returns the “default value” for a type.

impl Message for Instruction

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 Instruction

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