Enum lnp_rpc::RpcMsg

#[non_exhaustive]
pub enum RpcMsg {
    GetInfo,
    ListPeers,
    ListChannels,
    ListFunds,
    Listen(ListenAddr),
    ConnectPeer(LnpAddr),
    DisconnectPeer(LnpAddr),
    PingPeer,
    CreateChannel(CreateChannel),
    Send(Send),
    PayInvoice(PayInvoice),
    Progress(String),
    Success(OptionDetails),
    Failure(Failure),
    NodeInfo(NodeInfo),
    PeerInfo(PeerInfo),
    ChannelInfo(ChannelInfo),
    PeerList(ListPeerInfo),
    ChannelList(List<ChannelId>),
    FundsInfo(FundsInfo),
}

RPC API requests between LNP Node daemons and clients.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GetInfo

ListPeers

ListChannels

ListFunds

Listen(ListenAddr)

ConnectPeer(LnpAddr)

DisconnectPeer(LnpAddr)

PingPeer

CreateChannel(CreateChannel)

Requests creation of a new outbound channel by a client.

Send(Send)

PayInvoice(PayInvoice)

Progress(String)

Success(OptionDetails)

Failure(Failure)

NodeInfo(NodeInfo)

PeerInfo(PeerInfo)

ChannelInfo(ChannelInfo)

PeerList(ListPeerInfo)

ChannelList(List<ChannelId>)

FundsInfo(FundsInfo)

Implementations

impl RpcMsg

pub fn success() -> Self

Trait Implementations

impl Clone for RpcMsg

fn clone(&self) -> RpcMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RpcMsg

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

Formats the value using the given formatter.

impl Display for RpcMsg

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

Formats the value using the given formatter.

impl From<&str> for RpcMsg

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<ChannelInfo> for RpcMsg

fn from(v: ChannelInfo) -> Self

Converts to this type from the input type.

impl From<Failure> for RpcMsg

fn from(v: Failure) -> Self

Converts to this type from the input type.

impl From<FundsInfo> for RpcMsg

fn from(v: FundsInfo) -> Self

Converts to this type from the input type.

impl From<List<ChannelId>> for RpcMsg

fn from(v: List<ChannelId>) -> Self

Converts to this type from the input type.

impl From<ListPeerInfo> for RpcMsg

fn from(v: ListPeerInfo) -> Self

Converts to this type from the input type.

impl From<NodeInfo> for RpcMsg

fn from(v: NodeInfo) -> Self

Converts to this type from the input type.

impl From<PeerInfo> for RpcMsg

fn from(v: PeerInfo) -> Self

Converts to this type from the input type.

impl From<String> for RpcMsg

fn from(v: String) -> Self

Converts to this type from the input type.

impl StrictDecode for RpcMsg

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for RpcMsg

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.