Struct DestroyCell 

pub struct DestroyCell {
    pub circ_id: u32,
    pub reason: CloseReason,
    pub reason_int: u8,
    pub unused: Vec<u8>,
}

Circuit teardown cell.

DESTROY cells are sent to tear down a circuit. They include a reason code explaining why the circuit is being closed.

Wire Format

[ CircID ][ 4 (DESTROY) ][ Reason (1) ][ Padding ]

Example

use stem_rs::client::cell::DestroyCell;
use stem_rs::client::datatype::CloseReason;

let cell = DestroyCell::new(1, CloseReason::Requested);

Fields

circ_id: u32

Circuit ID to destroy.

reason: CloseReason

Reason for closing the circuit.

reason_int: u8

Integer value of the reason.

unused: Vec<u8>

Unused padding bytes.

Implementations

impl DestroyCell

pub fn new(circ_id: u32, reason: CloseReason) -> Self

Creates a new DESTROY cell.

Arguments

• circ_id - Circuit ID to destroy
• reason - Reason for closing the circuit

pub fn pack(&self, link_protocol: &LinkProtocol) -> Vec<u8>

Packs this cell into bytes for transmission.

pub fn unpack(payload: &[u8], circ_id: u32) -> Result<Self, Error>

Unpacks a DESTROY cell from payload bytes.

Trait Implementations

impl Clone for DestroyCell

fn clone(&self) -> DestroyCell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DestroyCell

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

Formats the value using the given formatter.

impl PartialEq for DestroyCell

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