Struct x11rb_protocol::protocol::xproto::QueryTextExtentsRequest

pub struct QueryTextExtentsRequest<'input> {
    pub font: Fontable,
    pub string: Cow<'input, [Char2b]>,
}

get text extents.

Query text extents from the X11 server. This request returns the bounding box of the specified 16-bit character string in the specified font or the font contained in the specified graphics context.

font_ascent is set to the maximum of the ascent metrics of all characters in the string. font_descent is set to the maximum of the descent metrics. overall_width is set to the sum of the character-width metrics of all characters in the string. For each character in the string, let W be the sum of the character-width metrics of all characters preceding it in the string. Let L be the left-side-bearing metric of the character plus W. Let R be the right-side-bearing metric of the character plus W. The lbearing member is set to the minimum L of all characters in the string. The rbearing member is set to the maximum R.

For fonts defined with linear indexing rather than 2-byte matrix indexing, each xcb_char2b_t structure is interpreted as a 16-bit number with byte1 as the most significant byte. If the font has no defined default character, undefined characters in the string are taken to have all zero metrics.

Characters with all zero metrics are ignored. If the font has no defined default_char, the undefined characters in the string are also ignored.

Fields

• font - The font to calculate text extents in. You can also pass a graphics context.
• string_len - The number of characters in string.
• string - The text to get text extents for.

Errors

• GContext - The specified graphics context does not exist.
• Font - The specified font does not exist.

Fields

font: Fontable

string: Cow<'input, [Char2b]>

Implementations

impl<'input> QueryTextExtentsRequest<'input>

pub fn serialize(self) -> BufWithFds<PiecewiseBuf<'input>>

Serialize this request into bytes for the provided connection

pub fn try_parse_request(
    header: RequestHeader,
    value: &'input [u8]
) -> Result<Self, ParseError>

Parse this request given its header, its body, and any fds that go along with it

pub fn into_owned(self) -> QueryTextExtentsRequest<'static>

Clone all borrowed data in this QueryTextExtentsRequest.

Trait Implementations

impl<'input> Clone for QueryTextExtentsRequest<'input>

fn clone(&self) -> QueryTextExtentsRequest<'input>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for QueryTextExtentsRequest<'input>

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

Formats the value using the given formatter.

impl<'input> Default for QueryTextExtentsRequest<'input>

fn default() -> QueryTextExtentsRequest<'input>

Returns the “default value” for a type.

impl<'input> Hash for QueryTextExtentsRequest<'input>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'input> Ord for QueryTextExtentsRequest<'input>

fn cmp(&self, other: &QueryTextExtentsRequest<'input>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'input> PartialEq<QueryTextExtentsRequest<'input>> for QueryTextExtentsRequest<'input>

fn eq(&self, other: &QueryTextExtentsRequest<'input>) -> bool

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

fn ne(&self, other: &QueryTextExtentsRequest<'input>) -> bool

This method tests for !=.

impl<'input> PartialOrd<QueryTextExtentsRequest<'input>> for QueryTextExtentsRequest<'input>

fn partial_cmp(
    &self,
    other: &QueryTextExtentsRequest<'input>
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'input> ReplyRequest for QueryTextExtentsRequest<'input>

type Reply = QueryTextExtentsReply

The kind of reply that this request generates.

impl<'input> Request for QueryTextExtentsRequest<'input>

const EXTENSION_NAME: Option<&'static str> = None

The protocol name of the extension that this request belongs to, or None for core requests

fn serialize(self, _major_opcode: u8) -> BufWithFds<Vec<u8>>

Serialize this request into its X11 protocol wire representation.

impl<'input> Eq for QueryTextExtentsRequest<'input>

impl<'input> StructuralEq for QueryTextExtentsRequest<'input>

impl<'input> StructuralPartialEq for QueryTextExtentsRequest<'input>