Struct ChannelEnd

pub struct ChannelEnd {
    pub state: State,
    pub ordering: Order,
    pub remote: Counterparty,
    pub connection_hops: Vec<ConnectionId>,
    pub version: Version,
    pub upgrade_sequence: u64,
}

Fields

state: State

ordering: Order

remote: Counterparty

connection_hops: Vec<ConnectionId>

version: Version

upgrade_sequence: u64

Implementations

impl ChannelEnd

pub fn new( state: State, ordering: Order, remote: Counterparty, connection_hops: Vec<ConnectionId>, version: Version, upgrade_sequence: u64, ) -> ChannelEnd

Creates a new ChannelEnd in state Uninitialized and other fields parametrized.

pub fn set_state(&mut self, s: State)

Updates the ChannelEnd to assume a new State ‘s’.

pub fn set_version(&mut self, v: Version)

pub fn set_counterparty_channel_id(&mut self, c: ChannelId)

pub fn is_open(&self) -> bool

Returns true if this ChannelEnd is in state State::Open.

pub fn state(&self) -> &State

pub fn ordering(&self) -> &Order

pub fn counterparty(&self) -> &Counterparty

pub fn connection_hops(&self) -> &Vec<ConnectionId>

pub fn version(&self) -> &Version

pub fn validate_basic(&self) -> Result<(), ChannelError>

pub fn state_matches(&self, other: &State) -> bool

Helper function to compare the state of this end with another state.

pub fn order_matches(&self, other: &Order) -> bool

Helper function to compare the order of this end with another order.

pub fn connection_hops_matches(&self, other: &Vec<ConnectionId>) -> bool

pub fn counterparty_matches(&self, other: &Counterparty) -> bool

pub fn version_matches(&self, other: &Version) -> bool

Trait Implementations

impl Clone for ChannelEnd

fn clone(&self) -> ChannelEnd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelEnd

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

Formats the value using the given formatter.

impl Default for ChannelEnd

fn default() -> ChannelEnd

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChannelEnd

fn deserialize<__D>( __deserializer: __D, ) -> Result<ChannelEnd, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChannelEnd

fn eq(&self, other: &ChannelEnd) -> 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 Protobuf<Channel> for ChannelEnd

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

where B: BufMut,

Encode into a buffer in Protobuf format.

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

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

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

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

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

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

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

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

fn decode_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Serialize for ChannelEnd

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Channel> for ChannelEnd

type Error = ChannelError

The type returned in the event of a conversion error.

fn try_from( value: Channel, ) -> Result<ChannelEnd, <ChannelEnd as TryFrom<Channel>>::Error>

Performs the conversion.

impl Eq for ChannelEnd

impl StructuralPartialEq for ChannelEnd