Struct runa_wayland_protocols::wayland::wl_output::v4::events::Name

pub struct Name<'a> {
    pub name: Str<'a>,
}

name of this output

Many compositors will assign user-friendly names to their outputs, show them to the user, allow the user to refer to an output, etc. The client may wish to know this name as well to offer the user similar behaviors.

The name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl_output globals. The name is only guaranteed to be unique for the compositor instance.

The same output name is used for all clients for a given wl_output global. Thus, the name can be shared across processes to refer to a specific wl_output global.

The name is not guaranteed to be persistent across sessions, thus cannot be used to reliably identify an output in e.g. configuration files.

Examples of names include ‘HDMI-A-1’, ‘WL-1’, ‘X11-1’, etc. However, do not assume that the name is a reflection of an underlying DRM connector, X11 connection, etc.

The name event is sent after binding the output object. This event is only sent once per output object, and the name does not change over the lifetime of the wl_output global.

Compositors may re-use the same output name if the wl_output global is destroyed and re-created later. Compositors should avoid re-using the same name if possible.

The name event will be followed by a done event.

Fields

name: Str<'a>

Implementations

impl<'a> Name<'a>

pub const OPCODE: u16 = 4u16

Trait Implementations

impl<'a> Clone for Name<'a>

fn clone(&self) -> Name<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Name<'a>

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for Name<'a>

fn deserialize(data: &'a [u8], fds: &'a [RawFd]) -> Result<Self, Error>

Deserialize from the given buffer. Returns deserialized message, and number of bytes and file descriptors consumed, respectively.

impl<'a> PartialEq<Name<'a>> for Name<'a>

fn eq(&self, other: &Name<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for Name<'a>

fn serialize<Fds: Extend<OwnedFd>>(self, buf: &mut BytesMut, fds: &mut Fds)

Serialize into the buffered writer. This function returns no errors, failures in seializing are generally program errors, and triggers panicking.

fn len(&self) -> u16

How many bytes will this message serialize to. Including the 8 byte header.

fn nfds(&self) -> u8

How many file descriptors will this message serialize to.

impl<'a> Copy for Name<'a>

impl<'a> Eq for Name<'a>

impl<'a> StructuralEq for Name<'a>

impl<'a> StructuralPartialEq for Name<'a>