Struct taffy::geometry::Line

pub struct Line<T> {
    pub start: T,
    pub end: T,
}

An abstract “line”. Represents any type that has a start and an end

Fields

start: T

The start position of a line

end: T

The end position of a line

Implementations

impl Line<OriginZeroLine>

pub(crate) fn span(self) -> u16

The number of tracks between the start and end lines

impl<T> Line<T>

pub fn map<R, F>(self, f: F) -> Line<R>

where F: Fn(T) -> R,

Applies the function f to both the width and height

This is used to transform a Line<T> into a Line<R>.

impl Line<bool>

pub const TRUE: Self = _

A Line<bool> with both start and end set to true

pub const FALSE: Self = _

A Line<bool> with both start and end set to false

impl<T: Add + Copy> Line<T>

pub fn sum(&self) -> <T as Add>::Output

Adds the start and end values together and returns the result

impl<T: GridCoordinate> Line<GenericGridPlacement<T>>

pub fn indefinite_span(&self) -> u16

Resolves the span for an indefinite placement (a placement that does not consist of two Tracks). Panics if called on a definite placement

impl Line<GridPlacement>

pub fn is_definite(&self) -> bool

Whether the track position is definite in this axis (or the item will need auto placement) The track position is definite if least one of the start and end positions is a NON-ZERO track index (0 is an invalid line in GridLine coordinates, and falls back to “auto” which is indefinite)

pub fn into_origin_zero( &self, explicit_track_count: u16, ) -> Line<GenericGridPlacement<OriginZeroLine>>

Apply a mapping function if the GridPlacement is a Track. Otherwise return self unmodified.

impl Line<GenericGridPlacement<OriginZeroLine>>

pub fn is_definite(&self) -> bool

Whether the track position is definite in this axis (or the item will need auto placement) The track position is definite if least one of the start and end positions is a track index

pub fn resolve_definite_grid_lines(&self) -> Line<OriginZeroLine>

If at least one of the of the start and end positions is a track index then the other end can be resolved into a track index purely based on the information contained with the placement specification

pub fn resolve_absolutely_positioned_grid_tracks( &self, ) -> Line<Option<OriginZeroLine>>

For absolutely positioned items:

• Tracks resolve to definite tracks
• For Spans:
  • If the other position is a Track, they resolve to a definite track relative to the other track
  • Else resolve to None
• Auto resolves to None

When finally positioning the item, a value of None means that the item’s grid area is bounded by the grid container’s border box on that side.

pub fn resolve_indefinite_grid_tracks( &self, start: OriginZeroLine, ) -> Line<OriginZeroLine>

If neither of the start and end positions is a track index then the other end can be resolved into a track index if a definite start position is supplied externally

impl<T: TaffyZero> Line<T>

pub const fn zero() -> Self

Returns a Line where both the start and end values are the zero value of the contained type (e.g. 0.0, Some(0.0), or Dimension::Length(0.0))

impl<T: TaffyAuto> Line<T>

pub const fn auto() -> Self

Returns a Line where both the start and end values are the auto value of the contained type (e.g. Dimension::Auto or LengthPercentageAuto::Auto)

impl<T: TaffyMinContent> Line<T>

pub const fn min_content() -> Self

Returns a Line where both the start and end values are the min_content value of the contained type (e.g. Dimension::Auto or LengthPercentageAuto::Auto)

impl<T: TaffyMaxContent> Line<T>

pub const fn max_content() -> Self

Returns a Line where both the start and end values are the max_content value of the contained type (e.g. Dimension::Auto or LengthPercentageAuto::Auto)

impl<T: TaffyFitContent> Line<T>

pub fn fit_content(argument: LengthPercentage) -> Self

Returns a Line with start and end set to the same fit-content(…) value with the given argument.

impl<T: FromLength> Line<T>

pub fn length<Input: Into<f32> + Copy>(value: Input) -> Self

Returns a Line where both the start and end values are the same given absolute length

impl<T: FromPercent> Line<T>

pub fn percent<Input: Into<f32> + Copy>(percent_value: Input) -> Self

Returns a Line where both the start and end values are the constant percent value of the contained type (e.g. 2.1, Some(2.1), or Dimension::Length(2.1))

Trait Implementations

impl<T: Clone> Clone for Line<T>

fn clone(&self) -> Line<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Line<T>

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

Formats the value using the given formatter.

impl Default for Line<GridPlacement>

Represents the start and end points of a GridItem within a given axis

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Line<T>

where Line<T>: Default, T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: FromLength> FromLength for Line<T>

fn from_length<Input: Into<f32> + Copy>(value: Input) -> Self

Converts into an Into<f32> into Self

impl<T: FromPercent> FromPercent for Line<T>

fn from_percent<Input: Into<f32> + Copy>(percent: Input) -> Self

Converts into an Into<f32> into Self

impl<T: PartialEq> PartialEq for Line<T>

fn eq(&self, other: &Line<T>) -> 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<T> Serialize for Line<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: TaffyAuto> TaffyAuto for Line<T>

const AUTO: Line<T> = _

The auto value for type implementing TaffyAuto

impl<T: TaffyFitContent> TaffyFitContent for Line<T>

fn fit_content(argument: LengthPercentage) -> Self

Converts a LengthPercentage into Self

impl TaffyGridLine for Line<GridPlacement>

fn from_line_index(index: i16) -> Self

Converts an i16 into Self

impl TaffyGridSpan for Line<GridPlacement>

fn from_span(span: u16) -> Self

Converts an iu6 into Self

impl<T: TaffyMaxContent> TaffyMaxContent for Line<T>

const MAX_CONTENT: Line<T> = _

The max_content value for type implementing TaffyZero

impl<T: TaffyMinContent> TaffyMinContent for Line<T>

const MIN_CONTENT: Line<T> = _

The min_content value for type implementing TaffyZero

impl<T: TaffyZero> TaffyZero for Line<T>

const ZERO: Line<T> = _

The zero value for type implementing TaffyZero

impl<T: Copy> Copy for Line<T>

impl<T: Eq> Eq for Line<T>

impl<T> StructuralPartialEq for Line<T>