Struct Offset 

pub struct Offset { /* private fields */ }

Represents offset internally used by osom tools. This is similar to Length, and internally is represented as a 32-bit signed integer. The point is that Offset can be added and removed from Length.

Implementations

impl Offset

pub const MAX_OFFSET: Offset

The maximal value Offset can take.

pub const MIN_OFFSET: Offset

The minimal value Offset can take.

pub const ZERO: Self

Represents Offset zero.

pub const ONE: Self

Represents Offset one.

pub const MINUS_ONE: Self

Represents Offset minus one.

pub const unsafe fn new_unchecked(value: i32) -> Self

Creates a new Offset out of i32.

Safety

This function does not validate value. It is up to the caller to ensure that its value is between Offset::MIN_OFFSET and Offset::MAX_OFFSET.

pub const fn try_from_i32(value: i32) -> Result<Self, OffsetError>

Creates a new Offset from i32.

Errors

For details see OffsetError.

pub const fn try_from_u32(value: u32) -> Result<Self, OffsetError>

Creates a new Offset from u32.

Errors

For details see OffsetError.

pub const fn as_i32(&self) -> i32

Turns the Offset into i32.

pub const fn as_isize(&self) -> isize

Turns the Offset into isize.

Trait Implementations

impl<T: AsI32> Add<T> for Offset

type Output = Offset

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T: AsI32> AddAssign<T> for Offset

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Offset

fn clone(&self) -> Offset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Offset

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

Formats the value using the given formatter.

impl Default for Offset

fn default() -> Offset

Returns the “default value” for a type.

impl Display for Offset

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

Formats the value using the given formatter.

impl From<Offset> for i32

fn from(value: Offset) -> Self

Converts to this type from the input type.

impl From<Offset> for isize

fn from(value: Offset) -> Self

Converts to this type from the input type.

impl Hash for Offset

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 Offset

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

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

fn partial_cmp(&self, other: &Offset) -> 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<T: AsI32> Sub<T> for Offset

type Output = Offset

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T: AsI32> SubAssign<T> for Offset

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<i32> for Offset

type Error = OffsetError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Offset

type Error = OffsetError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Offset

type Error = OffsetError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Offset

impl Eq for Offset

impl StructuralPartialEq for Offset