Struct font_types::NameId

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

Identifier for an informational string (or name).

A set of predefined identifiers exist for accessing names and other various metadata about the font and those are provided as associated constants on this type.

IDs 26 to 255, inclusive, are reserved for future standard names. IDs 256 to 32767, inclusive, are reserved for font-specific names such as those referenced by a font’s layout features.

For more detail, see https://learn.microsoft.com/en-us/typography/opentype/spec/name#name-ids

Implementations

impl NameId

pub const COPYRIGHT_NOTICE: Self = _

Copyright notice.

pub const FAMILY_NAME: Self = _

Font family name.

The font family name is used in combination with font subfamily name (ID 2), and should be shared among at most four fonts that differ only in weight or style (as described below).

pub const SUBFAMILY_NAME: Self = _

Font subfamily name.

The font subfamily name is used in combination with font family name (ID 1), and distinguishes the fonts in a group with the same font family name. This should be used for style and weight variants only (as described below).

pub const UNIQUE_ID: Self = _

Unique font identifier.

pub const FULL_NAME: Self = _

Full font name that reflects all family and relevant subfamily descriptors.

The full font name is generally a combination of IDs 1 and 2, or of IDs 16 and 17, or a similar human-readable variant.

pub const VERSION_STRING: Self = _

Version string.

Should begin with the syntax “Version number.number” (upper case, lower case, or mixed, with a space between “Version” and the number).

pub const POSTSCRIPT_NAME: Self = _

PostScript name for the font.

ID 6 specifies a string which is used to invoke a PostScript language font that corresponds to this OpenType font. When translated to ASCII, the name string must be no longer than 63 characters and restricted to the printable ASCII subset, codes 33 to 126, except for the 10 characters ‘[’, ‘]’, ‘(’, ‘)’, ‘{’, ‘}’, ‘<’, ‘>’, ‘/’, ‘%’.

pub const TRADEMARK: Self = _

Trademark; this is used to save any trademark notice/information for this font.

Such information should be based on legal advice. This is distinctly separate from the copyright.

pub const MANUFACTURER: Self = _

Manufacturer name.

pub const DESIGNER: Self = _

Name of the designer of the typeface.

pub const DESCRIPTION: Self = _

Description of the typeface.

Can contain revision information, usage recommendations, history, features, etc.

pub const VENDOR_URL: Self = _

URL of font vendor (with protocol, e.g., http://, ftp://).

If a unique serial number is embedded in the URL, it can be used to register the font.

pub const DESIGNER_URL: Self = _

URL of typeface designer (with protocol, e.g., http://, ftp://).

pub const LICENSE_DESCRIPTION: Self = _

License description.

A description of how the font may be legally used, or different example scenarios for licensed use. This field should be written in plain language, not legalese.

pub const LICENSE_URL: Self = _

URL where additional licensing information can be found.

pub const TYPOGRAPHIC_FAMILY_NAME: Self = _

Typographic family name.

The typographic family grouping doesn’t impose any constraints on the number of faces within it, in contrast with the 4-style family grouping (ID 1), which is present both for historical reasons and to express style linking groups.

pub const TYPOGRAPHIC_SUBFAMILY_NAME: Self = _

Typographic subfamily name.

This allows font designers to specify a subfamily name within the typographic family grouping. This string must be unique within a particular typographic family.

pub const COMPATIBLE_FULL_NAME: Self = _

Compatible full (Macintosh only).

On the Macintosh, the menu name is constructed using the FOND resource. This usually matches the full name. If you want the name of the font to appear differently than the Full Name, you can insert the compatible full name in ID 18.

pub const SAMPLE_TEXT: Self = _

Sample text.

This can be the font name, or any other text that the designer thinks is the best sample to display the font in.

pub const POSTSCRIPT_CID_NAME: Self = _

PostScript CID findfont name.

Its presence in a font means that the ID 6 holds a PostScript font name that is meant to be used with the “composefont” invocation in order to invoke the font in a PostScript interpreter.

pub const WWS_FAMILY_NAME: Self = _

WWS family name.

Used to provide a WWS-conformant family name in case the entries for IDs 16 and 17 do not conform to the WWS model.

pub const WWS_SUBFAMILY_NAME: Self = _

WWS subfamily name.

Used in conjunction with ID 21, this ID provides a WWS-conformant subfamily name (reflecting only weight, width and slope attributes) in case the entries for IDs 16 and 17 do not conform to the WWS model.

pub const LIGHT_BACKGROUND_PALETTE: Self = _

Light background palette.

This ID, if used in the CPAL table’s Palette Labels Array, specifies that the corresponding color palette in the CPAL table is appropriate to use with the font when displaying it on a light background such as white.

pub const DARK_BACKGROUND_PALETTE: Self = _

Dark background palette.

This ID, if used in the CPAL table’s Palette Labels Array, specifies that the corresponding color palette in the CPAL table is appropriate to use with the font when displaying it on a dark background such as black.

pub const VARIATIONS_POSTSCRIPT_NAME_PREFIX: Self = _

Variations PostScript name prefix.

If present in a variable font, it may be used as the family prefix in the PostScript Name Generation for Variation Fonts algorithm.

impl NameId

pub const fn new(raw: u16) -> Self

Create a new identifier from a raw u16 value.

pub fn predefined() -> impl Iterator<Item = Self> + Clone

Returns an iterator over the set of predefined identifiers according to the specification.

pub const fn to_u16(self) -> u16

Return the identifier as a u16.

pub const fn to_be_bytes(self) -> [u8; 2]

Return the memory representation of this identifier as a byte array in big-endian (network) byte order.

Trait Implementations

impl Clone for NameId

fn clone(&self) -> NameId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NameId

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

Formats the value using the given formatter.

impl Default for NameId

fn default() -> Self

Returns the “default value” for a type.

impl Display for NameId

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

Formats the value using the given formatter.

impl From<u16> for NameId

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Hash for NameId

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 Ord for NameId

fn cmp(&self, other: &NameId) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NameId

fn eq(&self, other: &NameId) -> 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 PartialOrd for NameId

fn partial_cmp(&self, other: &NameId) -> 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 Scalar for NameId

type Raw = [u8; 2]

The raw byte representation of this type.

fn to_raw(self) -> [u8; 2]

Encode this type as raw big-endian bytes

fn from_raw(raw: [u8; 2]) -> Self

Create an instance of this type from raw big-endian bytes

fn read(slice: &[u8]) -> Option<Self>

Attempt to read a scalar from a slice.

impl Zeroable for NameId

fn zeroed() -> Self

Calls zeroed.

impl AnyBitPattern for NameId

impl Copy for NameId

impl Eq for NameId

impl StructuralPartialEq for NameId