Struct stam::Offset

pub struct Offset {
    pub begin: Cursor,
    pub end: Cursor,
}

Text selection offset. Specifies begin and end offsets to select a range of a text, via two Cursor instances. The end-point is non-inclusive.

Fields

begin: Cursor

end: Cursor

Implementations

impl Offset

pub fn new(begin: Cursor, end: Cursor) -> Self

pub fn simple(begin: usize, end: usize) -> Self

Shortcut constructor to create a simple begin-aligned offset (less boilerplate)

pub fn whole() -> Self

Shortcut constructor to create a constructor that selects everything of the target

pub fn is_simple(&self) -> bool

Returns true if this Offset only uses begin-aligned cursors

pub fn is_simple_or_whole(&self) -> bool

Returns true if this Offset only uses begin-aligned cursors, or if it selects the whole target

pub fn to_json(&self) -> Result<String, StamError>

Writes a datavalue to one STAM JSON string, with appropriate formatting

pub fn to_json_compact(&self) -> Result<String, StamError>

Writes a datavalue to one STAM JSON string, without any indentation

pub fn mode(&self) -> OffsetMode

Trait Implementations

impl Clone for Offset

fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for Offset

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for Offset

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

Formats the value using the given formatter.

impl<'bytes, Ctx> Decode<'bytes, Ctx> for Offset

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx ) -> Result<Offset, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl Default for Offset

fn default() -> Self

The default constructor selects the text as a whole

impl<'de> Deserialize<'de> for Offset

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Ctx> Encode<Ctx> for Offset

fn encode<__W777>( &self, __e777: &mut Encoder<__W777>, __ctx777: &mut Ctx ) -> Result<(), Error<__W777::Error>>

where __W777: Write,

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl From<&Offset> for OffsetMode

fn from(offset: &Offset) -> OffsetMode

Converts to this type from the input type.

impl From<&ResultItem<'_, TextSelection>> for Offset

fn from(textselection: &ResultItem<'_, TextSelection>) -> Offset

Converts to this type from the input type.

impl From<&ResultTextSelection<'_>> for Offset

fn from(textselection: &ResultTextSelection<'_>) -> Offset

Converts to this type from the input type.

impl From<&TextSelection> for Offset

fn from(textselection: &TextSelection) -> Offset

Converts to this type from the input type.

impl From<TextSelection> for Offset

fn from(textselection: TextSelection) -> Offset

Converts to this type from the input type.

impl PartialEq for Offset

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Offset

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Offset