Struct OpGetDeviceDump 

pub struct OpGetDeviceDump<'r> { /* private fields */ }

Available on crate feature wireguard only.

Retrieve WireGuard device ~~~~~~~~~~~~~~~~~~~~~~~~~

The command should be called with one but not both of:

- ``WGDEVICE_A_IFINDEX`` - ``WGDEVICE_A_IFNAME``

The kernel will then return several messages (``NLM_F_MULTI``). It is possible that all of the allowed IPs of a single peer will not fit within a single netlink message. In that case, the same peer will be written in the following message, except it will only contain ``WGPEER_A_PUBLIC_KEY`` and ``WGPEER_A_ALLOWEDIPS``. This may occur several times in a row for the same peer. It is then up to the receiver to coalesce adjacent peers. Likewise, it is possible that all peers will not fit within a single message. So, subsequent peers will be sent in following messages, except those will only contain ``WGDEVICE_A_IFNAME`` and ``WGDEVICE_A_PEERS``. It is then up to the receiver to coalesce these messages to form the complete list of peers.

Since this is an ``NLA_F_DUMP`` command, the final message will always be ``NLMSG_DONE``, even if an error occurs. However, this ``NLMSG_DONE`` message contains an integer error code. It is either zero or a negative error code corresponding to the errno.

Flags: uns-admin-perm Request attributes:

• .push_ifindex()
• .push_ifname()

Reply attributes:

• .get_ifindex()
• .get_ifname()
• .get_private_key()
• .get_public_key()
• .get_flags()
• .get_listen_port()
• .get_fwmark()
• .get_peers()

Implementations

impl<'r> OpGetDeviceDump<'r>

pub fn new(request: Request<'r>) -> Self

pub fn encode_request<'buf>( buf: &'buf mut Vec<u8>, ) -> PushWgdevice<&'buf mut Vec<u8>>

pub fn encode(&mut self) -> PushWgdevice<&mut Vec<u8>>

pub fn into_encoder(self) -> PushWgdevice<RequestBuf<'r>>

pub fn decode_request<'a>(buf: &'a [u8]) -> IterableWgdevice<'a>

Trait Implementations

impl<'r> Debug for OpGetDeviceDump<'r>

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

Formats the value using the given formatter.

impl NetlinkRequest for OpGetDeviceDump<'_>

type ReplyType<'buf> = IterableWgdevice<'buf>

fn protocol(&self) -> Protocol

Netlink protocol to use

fn flags(&self) -> u16

Additional flags specified in the message header

fn payload(&self) -> &[u8]

Encoded payload of the message (without message header)

fn decode_reply<'buf>(buf: &'buf [u8]) -> Self::ReplyType<'buf>

fn lookup( buf: &[u8], offset: usize, missing_type: Option<u16>, ) -> (Vec<(&'static str, usize)>, Option<&'static str>)

Lookup an attribute and it’s parents in the request payload by offset