Struct FontCharacteristics 

pub struct FontCharacteristics(/* private fields */);

Font weight and decorations. Matches values defined here.

Implementations

impl FontCharacteristics

pub const BOLD: Self

pub const ITALIC: Self

pub const UNDERLINE: Self

pub const SUPERSCRIPT: Self

pub const SUBSCRIPT: Self

pub const STRIKE_THROUGH: Self

pub const OVERLINE: Self

impl FontCharacteristics

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u128

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u128) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u128) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u128) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FontCharacteristics

pub const fn iter(&self) -> Iter<FontCharacteristics>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<FontCharacteristics>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for FontCharacteristics

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

Formats the value using the given formatter.

impl BitAnd for FontCharacteristics

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

The bitwise and (&) of the bits in self and other.

type Output = FontCharacteristics

The resulting type after applying the & operator.

impl BitAndAssign for FontCharacteristics

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for FontCharacteristics

fn bitor(self, other: FontCharacteristics) -> Self

The bitwise or (|) of the bits in self and other.

type Output = FontCharacteristics

The resulting type after applying the | operator.

impl BitOrAssign for FontCharacteristics

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for FontCharacteristics

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

The bitwise exclusive-or (^) of the bits in self and other.

type Output = FontCharacteristics

The resulting type after applying the ^ operator.

impl BitXorAssign for FontCharacteristics

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for FontCharacteristics

fn clone(&self) -> FontCharacteristics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FontCharacteristics

impl Debug for FontCharacteristics

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

Formats the value using the given formatter.

impl Default for FontCharacteristics

fn default() -> FontCharacteristics

Returns the “default value” for a type.

impl DerefToPyAny for FontCharacteristics

impl Eq for FontCharacteristics

impl Extend<FontCharacteristics> for FontCharacteristics

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for FontCharacteristics

const FLAGS: &'static [Flag<FontCharacteristics>]

The set of defined flags.

type Bits = u128

The underlying bits type.

fn bits(&self) -> u128

Get the underlying bits value.

fn from_bits_retain(bits: u128) -> FontCharacteristics

Convert from a bits value exactly.

fn all_named() -> FontCharacteristics

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<FontCharacteristics> for FontCharacteristics

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl<'a, 'py> FromPyObject<'a, 'py> for FontCharacteristics

where Self: Clone,

const INPUT_TYPE: PyStaticExpr = <FontCharacteristics as ::pyo3::PyTypeInfo>::TYPE_HINT

Available on crate feature experimental-inspect only.

Provides the type hint information for this type when it appears as an argument.

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

fn type_input() -> TypeInfo

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as an argument.

impl Hash for FontCharacteristics

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for FontCharacteristics

type Item = FontCharacteristics

The type of the elements being iterated over.

type IntoIter = Iter<FontCharacteristics>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'py> IntoPyObject<'py> for FontCharacteristics

const OUTPUT_TYPE: PyStaticExpr = <FontCharacteristics as ::pyo3::PyTypeInfo>::TYPE_HINT

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as a return value.

type Target = FontCharacteristics

The Python output type

type Output = Bound<'py, <FontCharacteristics as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

fn type_output() -> TypeInfo

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as a return value.

impl LowerHex for FontCharacteristics

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

Formats the value using the given formatter.

impl Not for FontCharacteristics

fn not(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

type Output = FontCharacteristics

The resulting type after applying the ! operator.

impl Octal for FontCharacteristics

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

Formats the value using the given formatter.

impl Ord for FontCharacteristics

fn cmp(&self, other: &FontCharacteristics) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FontCharacteristics

fn eq(&self, other: &FontCharacteristics) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FontCharacteristics

fn partial_cmp(&self, other: &FontCharacteristics) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PublicFlags for FontCharacteristics

type Primitive = u128

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl PyClass for FontCharacteristics

const NAME: &str = "FontCharacteristics"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for FontCharacteristics

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Font weight and decorations. /// Matches values defined [here](https://graphviz.org/docs/outputs/canon/#xdot).

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<FontCharacteristics as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<FontCharacteristics>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForFontCharacteristics

Available on crate feature multiple-pymethods only.

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for FontCharacteristics

const TEXT_SIGNATURE: &'static str = "(bold=False, italic=False, underline=False, superscript=False, subscript=False, strike_through=False, overline=False)"

impl PyTypeInfo for FontCharacteristics

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

const TYPE_HINT: PyStaticExpr

Available on crate feature experimental-inspect only.

Provides the full python type as a type hint.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl StructuralPartialEq for FontCharacteristics

impl Sub for FontCharacteristics

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

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = FontCharacteristics

The resulting type after applying the - operator.

impl SubAssign for FontCharacteristics

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FontCharacteristics

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

Formats the value using the given formatter.