Struct Request 

pub struct Request<'buf> { /* private fields */ }

Available on crate feature wireguard only.

Implementations

impl Request<'static>

pub fn new() -> Self

pub fn new_from_buf(buf: Vec<u8>) -> Self

pub fn into_buf(self) -> Vec<u8>

impl<'buf> Request<'buf>

pub fn new_with_buf(buf: &'buf mut Vec<u8>) -> Self

pub fn new_extend(buf: &'buf mut Vec<u8>) -> Self

pub fn buf(&self) -> &Vec<u8>

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

pub fn set_create(self) -> Self

Set NLM_F_CREATE flag

pub fn set_excl(self) -> Self

Set NLM_F_EXCL flag

pub fn set_replace(self) -> Self

Set NLM_F_REPLACE flag

pub fn set_change(self) -> Self

Set NLM_F_CREATE and NLM_F_REPLACE flag

pub fn set_append(self) -> Self

Set NLM_F_APPEND flag

pub fn set_flags(self, flags: u16) -> Self

Set self.flags |= flags

pub fn unset_flags(self, flags: u16) -> Self

Set self.flags ^= self.flags & flags

pub fn op_get_device_dump(self) -> OpGetDeviceDump<'buf>

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()

pub fn op_set_device_do(self) -> OpSetDeviceDo<'buf>

Set WireGuard device

This command should be called with a wgdevice set, containing one but not both of WGDEVICE_A_IFINDEX and WGDEVICE_A_IFNAME.

It is possible that the amount of configuration data exceeds that of the maximum message length accepted by the kernel. In that case, several messages should be sent one after another, with each successive one filling in information not contained in the prior. Note that if WGDEVICE_F_REPLACE_PEERS is specified in the first message, it probably should not be specified in fragments that come after, so that the list of peers is only cleared the first time but appended after. Likewise for peers, if WGPEER_F_REPLACE_ALLOWEDIPS is specified in the first message of a peer, it likely should not be specified in subsequent fragments.

If an error occurs, NLMSG_ERROR will reply containing an errno.

Flags: uns-admin-perm

Request attributes:

• .push_ifindex()
• .push_ifname()
• .push_private_key()
• .push_public_key()
• .push_flags()
• .push_listen_port()
• .push_fwmark()
• .array_peers()

Trait Implementations

impl<'buf> Debug for Request<'buf>

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

Formats the value using the given formatter.