Struct PointerU16

pub struct PointerU16(/* private fields */);

Pointer implementation for u16.

Implementations

impl PointerU16

pub fn new(value: usize) -> Option<Self>

Safe constructor for the pointer.

Returns None if the value provided is out of bounds for the pointer type.

Examples

use syntree::pointer::Pointer;
use syntree::pointer::PointerU16;

 let v = PointerU16::new(0).ok_or("out of bounds")?;
assert_eq!(v.get(), 0);
 let v = PointerU16::new(42).ok_or("out of bounds")?;
assert_eq!(v.get(), 42);

pub fn get(self) -> usize

Get the index of a pointer.

Examples

use syntree::pointer::Pointer;
use syntree::pointer::PointerU16;

 let v = PointerU16::new(0).ok_or("out of bounds")?;
assert_eq!(v.get(), 0);
 let v = PointerU16::new(42).ok_or("out of bounds")?;
assert_eq!(v.get(), 42);

Trait Implementations

impl Clone for PointerU16

fn clone(&self) -> PointerU16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PointerU16

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

Formats the value using the given formatter.

impl Default for PointerU16

Construct a default value.

use syntree::pointer::Pointer;
use syntree::pointer::PointerU16;

 let v = PointerU16::default();
assert_eq!(v.get(), 0);

fn default() -> Self

Returns the “default value” for a type.

impl Hash for PointerU16

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 PointerU16

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

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

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

Pointer used for u16 type.

use syntree::pointer::Pointer;
use syntree::pointer::PointerU16;

 let v = PointerU16::new(0).ok_or("out of bounds")?;
assert_eq!(v.get(), 0);
 let v = PointerU16::new(42).ok_or("out of bounds")?;
assert_eq!(v.get(), 42);

fn new(value: usize) -> Option<Self>

Safe constructor for the pointer.

fn get(self) -> usize

Get the index of a pointer.

impl Copy for PointerU16

impl Eq for PointerU16

impl StructuralPartialEq for PointerU16