Skip to main content

ExternalWorkbookLink

Struct ExternalWorkbookLink 

Source
pub struct ExternalWorkbookLink {
    pub target: String,
    pub sheet_names: Vec<String>,
    pub defined_names: Vec<(String, String)>,
}
Expand description

A reference to another workbook, used by this workbook’s formulas (<externalReference> in xl/workbook.xml’s <externalReferences>, plus a dedicated xl/externalLinks/externalLinkN.xml part, CT_ExternalReference/CT_ExternalLink). Storage only: this crate neither resolves the referenced workbook nor recomputes any formula against it — a formula cell referencing this link (e.g. "[1]Feuil1!A1" or "'[Budget.xlsx]Feuil1'!A1") is written/read as plain formula text like any other, this type only accounts for the link itself (the part Excel needs to know the reference is legitimate and to cache a fallback value while the other file is closed).

Fields§

§target: String

The other workbook’s path/URL, written as an external (TargetMode="External") relationship target on this link’s own xl/externalLinks/_rels/externalLinkN.xml.rels — same shape as HyperlinkTarget::External. Can be an absolute path ("file:///C:/Budget.xlsx"), a relative one ("Budget.xlsx"), or a URL.

§sheet_names: Vec<String>

The other workbook’s own sheet names, in order (<sheetNames>/<sheetName val="..">) — Excel uses these to resolve [1]SheetName!.. formula references while the other file is closed.

§defined_names: Vec<(String, String)>

Named ranges/constants defined in the other workbook that this one’s formulas reference, as (name, refersTo text) pairs (<definedNames>/<definedName name=".." refersTo="..">).

Implementations§

Source

pub fn new(target: impl Into<String>) -> ExternalWorkbookLink

Creates an external workbook link with no sheet names/defined names yet.

Source

pub fn with_sheet_name(self, name: impl Into<String>) -> ExternalWorkbookLink

Appends a sheet name and returns the link for chaining.

Source

pub fn with_defined_name( self, name: impl Into<String>, refers_to: impl Into<String>, ) -> ExternalWorkbookLink

Appends a defined name reference and returns the link for chaining.

Trait Implementations§

Source§

fn clone(&self) -> ExternalWorkbookLink

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Formats the value using the given formatter. Read more
Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.