Struct Margin

pub struct Margin {
    pub left: i8,
    pub right: i8,
    pub top: i8,
    pub bottom: i8,
}

A value for all four sides of a rectangle, often used to express padding or spacing.

Can be added and subtracted to/from Rects.

Negative margins are possible, but may produce weird behavior. Use with care.

All values are stored as i8 to keep the size of Margin small. If you want floats, use crate::Marginf instead.

Fields

left: i8

right: i8

top: i8

bottom: i8

Implementations

impl Margin

pub const ZERO: Self

pub const fn same(margin: i8) -> Self

The same margin on every side.

pub const fn symmetric(x: i8, y: i8) -> Self

Margins with the same size on opposing sides

pub const fn leftf(self) -> f32

Left margin, as f32

pub const fn rightf(self) -> f32

Right margin, as f32

pub const fn topf(self) -> f32

Top margin, as f32

pub const fn bottomf(self) -> f32

Bottom margin, as f32

pub fn sum(self) -> Vec2

Total margins on both sides

pub const fn left_top(self) -> Vec2

pub const fn right_bottom(self) -> Vec2

pub const fn is_same(self) -> bool

Are the margin on every side the same?

pub fn expand_rect(self, rect: Rect) -> Rect

👎Deprecated: Use rect + margin instead

pub fn shrink_rect(self, rect: Rect) -> Rect

👎Deprecated: Use rect - margin instead

Trait Implementations

impl Add<Margin> for Rect

Rect + Margin

type Output = Rect

The resulting type after applying the + operator.

fn add(self, margin: Margin) -> Self

Performs the + operation.

impl Add<i8> for Margin

Margin + i8

type Output = Margin

The resulting type after applying the + operator.

fn add(self, v: i8) -> Self

Performs the + operation.

impl Add for Margin

Margin + Margin

type Output = Margin

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Margin> for Rect

Rect += Margin

fn add_assign(&mut self, margin: Margin)

Performs the += operation.

impl AddAssign<i8> for Margin

Margin += i8

fn add_assign(&mut self, v: i8)

Performs the += operation.

impl Clone for Margin

fn clone(&self) -> Margin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Margin

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

Formats the value using the given formatter.

impl Default for Margin

fn default() -> Margin

Returns the “default value” for a type.

impl Div<f32> for Margin

Margin / f32

type Output = Margin

The resulting type after applying the / operator.

fn div(self, v: f32) -> Self

Performs the / operation.

impl DivAssign<f32> for Margin

Margin /= f32

fn div_assign(&mut self, v: f32)

Performs the /= operation.

impl From<Margin> for Marginf

fn from(margin: Margin) -> Self

Converts to this type from the input type.

impl From<Marginf> for Margin

fn from(marginf: Marginf) -> Self

Converts to this type from the input type.

impl From<Vec2> for Margin

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<f32> for Margin

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<i8> for Margin

fn from(v: i8) -> Self

Converts to this type from the input type.

impl Mul<f32> for Margin

Margin * f32

type Output = Margin

The resulting type after applying the * operator.

fn mul(self, v: f32) -> Self

Performs the * operation.

impl MulAssign<f32> for Margin

Margin *= f32

fn mul_assign(&mut self, v: f32)

Performs the *= operation.

impl PartialEq for Margin

fn eq(&self, other: &Margin) -> 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 Sub<Margin> for Rect

Rect - Margin

type Output = Rect

The resulting type after applying the - operator.

fn sub(self, margin: Margin) -> Self

Performs the - operation.

impl Sub<i8> for Margin

Margin - i8

type Output = Margin

The resulting type after applying the - operator.

fn sub(self, v: i8) -> Self

Performs the - operation.

impl Sub for Margin

Margin - Margin

type Output = Margin

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Margin> for Rect

Rect -= Margin

fn sub_assign(&mut self, margin: Margin)

Performs the -= operation.

impl SubAssign<i8> for Margin

Margin -= i8

fn sub_assign(&mut self, v: i8)

Performs the -= operation.

impl Copy for Margin

impl Eq for Margin

impl StructuralPartialEq for Margin