Enum SheetLocator 

pub enum SheetLocator<'a> {
    Current,
    Id(SheetId),
    Name(Cow<'a, str>),
}

Sheet locator that can carry either a resolved id, a name, or the current sheet.

Variants

Current

Reference is scoped to the sheet containing the formula.

Id(SheetId)

Resolved sheet id.

Name(Cow<'a, str>)

Unresolved sheet name (borrowed or owned).

Implementations

impl<'a> SheetLocator<'a>

pub const fn current() -> Self

Construct a locator for the current sheet.

pub const fn from_id(id: SheetId) -> Self

Construct from a resolved sheet id.

pub fn from_name(name: impl Into<Cow<'a, str>>) -> Self

Construct from a sheet name (borrowed or owned).

pub const fn id(&self) -> Option<SheetId>

Returns the sheet id if present.

pub fn name(&self) -> Option<&str>

Returns the sheet name if present.

pub const fn is_current(&self) -> bool

Returns true if this locator refers to the current sheet.

pub fn as_ref(&self) -> SheetLocator<'_>

Borrow the locator, ensuring any owned name is exposed by reference.

pub fn into_owned(self) -> SheetLocator<'static>

Convert the locator into an owned 'static form.

Trait Implementations

impl<'a> Clone for SheetLocator<'a>

fn clone(&self) -> SheetLocator<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SheetLocator<'a>

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

Formats the value using the given formatter.

impl<'a> Default for SheetLocator<'a>

fn default() -> SheetLocator<'a>

Returns the “default value” for a type.

impl<'a> From<&'a str> for SheetLocator<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<String> for SheetLocator<'a>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<'a> From<u16> for SheetLocator<'a>

fn from(value: SheetId) -> Self

Converts to this type from the input type.

impl<'a> Hash for SheetLocator<'a>

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<'a> PartialEq for SheetLocator<'a>

fn eq(&self, other: &SheetLocator<'a>) -> 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<'a> Eq for SheetLocator<'a>

impl<'a> StructuralPartialEq for SheetLocator<'a>