Struct Size

pub struct Size {
    pub start_byte: usize,
    pub end_byte: usize,
}

A range of bytes.

Fields

start_byte: usize

The lowest index included in the range.

end_byte: usize

The highest index included in the range.

Implementations

impl Size

pub const fn new(start_byte: usize, end_byte: usize) -> Self

Creates a new range from the provided values.

pub const fn qword() -> Self

Returns Size::new(0, 7).

pub fn union(&self, other: &Self) -> Self

Returns a union of the two ranges.

pub fn contains(&self, other: &Self) -> bool

Returns true if the size contains other.

pub fn overlaps(&self, other: &Self) -> bool

Returns true if the size and other overlap.

pub fn overlapping_area(&self, other: Size) -> Option<Size>

Returns the overlapping area between the two sizes. If the two sizes do not overlap, returns None.

pub fn split_by_overlap( &self, existing_size: Size, ) -> Option<(Option<Size>, Size, Option<Size>)>

Computes the union of the two sizes, and splits it by overlapping area. Returns None is the sizes do not overlap.

Returns a triple of (before, overlapping, after). before is the area in the union < overlapping. overlapping is the overlapping area between the two sizes. after is the area in the union > overlapping.

pub fn num_bytes(&self) -> usize

The number of bytes in the size.

pub fn try_glue(&self, other: &Size) -> Option<Size>

If the size and other occur consecutively one after the other, returns a size that contains both.

pub fn select_mask(&self, mask: Option<u64>) -> Option<u64>

Crops mask to only have bits set in the area described by this size.

pub fn iter_byte_indices(&self) -> impl Iterator<Item = usize>

Returns an iterator that yields all byte indices in this size

Trait Implementations

impl Clone for Size

fn clone(&self) -> Size

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Size

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Size

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 JsonSchema for Size

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for Size

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Size

impl Eq for Size

impl StructuralPartialEq for Size