Struct CTRubyAlignment 

#[repr(transparent)]
pub struct CTRubyAlignment(pub u8);

Available on crate feature CTRubyAnnotation only.

These constants specify how to align the ruby annotation and the base text relative to each other when they don’t have the same length.

CoreText will determine the alignment.

The ruby text is aligned with the start edge of the base text.

The ruby text is centered within the width of the base text. If the ruby text is wider than the base text the base text is centered in the width of the ruby text.

The ruby text is aligned with the end edge of the base text.

If the width of the ruby text is less than the width of the base text, the ruby text is evenly distributed over the width of the base text, with the first letter of the ruby text aligning with the first letter of the base text and the last letter of the ruby text aligning with the last letter of the base text. If the width of the base text is less than the width of the ruby text, the base text is evenly distributed over the width of the ruby text.

If the width of the ruby text is less than the width of the base text, the ruby text is evenly distributed over the width of the base text, with a certain amount of space, usually half the inter-character width of the ruby text, before the first and after the last character. If the width of the base text is less than the width of the ruby text, the base text is similarly aligned to the width of the ruby text.

If the ruby text is not adjacent to a line edge it is aligned as with kCTRubyAlignmentAuto. If it is adjacent to a line edge the end of ruby text adjacent to the line edge is aligned to the line edge. This is only relevant if the width of the ruby text is greater than the width of the base text; otherwise alignment is as with kCTRubyAlignmentAuto.

See also Apple’s documentation

Tuple Fields

0: u8

Implementations

impl CTRubyAlignment

pub const Invalid: Self

pub const Auto: Self

pub const Start: Self

pub const Center: Self

pub const End: Self

pub const DistributeLetter: Self

pub const DistributeSpace: Self

pub const LineEdge: Self

Trait Implementations

impl Clone for CTRubyAlignment

fn clone(&self) -> CTRubyAlignment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CTRubyAlignment

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

Formats the value using the given formatter.

impl Encode for CTRubyAlignment

Available on crate feature objc2 only.

const ENCODING: Encoding = u8::ENCODING

The Objective-C type-encoding for this type.

impl Hash for CTRubyAlignment

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 CTRubyAlignment

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for CTRubyAlignment

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

Available on crate feature objc2 only.

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for CTRubyAlignment

impl Eq for CTRubyAlignment

impl StructuralPartialEq for CTRubyAlignment