Struct vimwiki::elements::Region

pub struct Region { /* fields omitted */ }

Represents a region in a string or file, comprised of a start and end

Implementations

impl Region

pub fn new(offset: usize, len: usize) -> Self

Constructs a new region with the given offset and length, containing no extra information

pub fn new_with_position(offset: usize, len: usize, position: Position) -> Self

Constructs a new region with the given offset, length, and extra information about the line & column position

pub fn with_position(self, position: Position) -> Self

Consumes the given region and returns a new one with its position set to the provided position

pub fn from_span_with_position(span: Span<'_>) -> Self

Constructs a new region based on the offset and length of the given span. Additionally, computes the line & column position of the region.

pub fn contains(&self, offset: usize) -> bool

Checks if a position is contained within this region

pub fn offset(&self) -> usize

The offset of the region relative to some span of input

pub fn len(&self) -> usize

The length of the region

pub fn is_empty(&self) -> bool

Returns true if the length of the region is zero

pub fn position(&self) -> Option<Position>

Returns the position of the region relative to some span of input

Can be none if the region was not constructed with a position

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Region

impl Debug for Region

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

Formats the value using the given formatter.

impl Default for Region

fn default() -> Region

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Region

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Region

impl From<(usize, usize)> for Region

fn from(coords: (usize, usize)) -> Self

Performs the conversion.

impl From<Range<usize>> for Region

fn from(range: Range<usize>) -> Self

Converts from start..end to Region { offset: start, len: end - start } where end < start will result in a length of zero

impl From<RangeInclusive<usize>> for Region

fn from(range: RangeInclusive<usize>) -> Self

Converts from start..=end to Region { offset: start, len: end - start + 1 } where end + 1 < start will result in a length of zero

impl From<RangeTo<usize>> for Region

fn from(range: RangeTo<usize>) -> Self

Converts from ..end to Region { offset: 0, len: end }

impl From<RangeToInclusive<usize>> for Region

fn from(range: RangeToInclusive<usize>) -> Self

Converts from ..=end to Region { offset: 0, len: end + 1 }

impl Hash for Region

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Region> for Region

fn eq(&self, other: &Region) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Region) -> bool

This method tests for !=.

impl Serialize for Region

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Region

impl StructuralPartialEq for Region