Struct spreadsheet_ods::WorkBook

source · [−]

pub struct WorkBook { /* private fields */ }

Expand description

Book is the main structure for the Spreadsheet.

Implementations

source

impl WorkBook

source

pub fn new_empty() -> Self

Creates a new, completely empty workbook.

WorkBook::locale_settings can be used to initialize default styles.

source

pub fn new(locale: Locale) -> Self

Creates a new workbook, and initializes default styles according to the given locale.

If the locale is not supported no ValueFormat’s are set and all depends on the application opening the spreadsheet.

The available locales can be activated via feature-flags.

source

pub fn locale_settings(&mut self, locale: Locale)

Creates a set of default formats and styles for every value-type.

If the locale is not supported no ValueFormat’s are set and all depends on the application opening the spreadsheet.

The available locales can be activated via feature-flags.

source

pub fn version(&self) -> &String

ODS version. Defaults to 1.3.

source

pub fn set_version(&mut self, version: String)

ODS version. Defaults to 1.3. It’s not advised to set another value.

source

pub fn config(&self) -> &WorkBookConfig

Configuration flags.

source

pub fn config_mut(&mut self) -> &mut WorkBookConfig

Configuration flags.

source

pub fn num_sheets(&self) -> usize

Number of sheets.

source

pub fn sheet_idx<S: AsRef<str>>(&self, name: S) -> Option<usize>

Finds the sheet index by the sheet-name.

source

pub fn detach_sheet(&mut self, n: usize) -> Detached<usize, Sheet>

Detaches a sheet. Useful if you have to make mutating calls to the workbook and the sheet intermixed.

Warning

The sheet has to be re-attached before saving the workbook.

Panics

Panics if the sheet has already been detached. Panics if n is out of bounds.

source

pub fn attach_sheet(&mut self, sheet: Detached<usize, Sheet>)

Reattaches the sheet in the place it was before.

Panics

Panics if n is out of bounds.

source

pub fn sheet(&self, n: usize) -> &Sheet

Returns a certain sheet.

Panics

Panics if n is out of bounds.

source

pub fn sheet_mut(&mut self, n: usize) -> &mut Sheet

Returns a certain sheet.

Panics

Panics if n does not exist.

source

pub fn insert_sheet(&mut self, i: usize, sheet: Sheet)

Inserts the sheet at the given position.

source

pub fn push_sheet(&mut self, sheet: Sheet)

Appends a sheet.

source

pub fn remove_sheet(&mut self, n: usize) -> Sheet

Removes a sheet from the table.

Panics

Panics if the sheet was detached.

source

pub fn add_def_style(&mut self, value_type: ValueType, style: &CellStyleRef)

Adds a default-style for all new values. This information is only used when writing the data to the ODS file.

source

pub fn def_style(&self, value_type: ValueType) -> Option<&String>

Returns the default style name.

source

pub fn add_font(&mut self, font: FontFaceDecl)

Adds a font.

source

pub fn remove_font(&mut self, name: &str) -> Option<FontFaceDecl>

Removes a font.

source

pub fn font(&self, name: &str) -> Option<&FontFaceDecl>

Returns the FontDecl.

source

pub fn font_mut(&mut self, name: &str) -> Option<&mut FontFaceDecl>

Returns a mutable FontDecl.

source

pub fn add_tablestyle(&mut self, style: TableStyle) -> TableStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

source

pub fn remove_tablestyle(&mut self, name: &str) -> Option<TableStyle>

Removes a style.

source

pub fn tablestyle(&self, name: &str) -> Option<&TableStyle>

Returns the style.

source

pub fn tablestyle_mut(&mut self, name: &str) -> Option<&mut TableStyle>

Returns the mutable style.

source

pub fn add_rowstyle(&mut self, style: RowStyle) -> RowStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

source

pub fn remove_rowstyle(&mut self, name: &str) -> Option<RowStyle>

Removes a style.

source

pub fn rowstyle(&self, name: &str) -> Option<&RowStyle>

Returns the style.

source

pub fn rowstyle_mut(&mut self, name: &str) -> Option<&mut RowStyle>

Returns the mutable style.

source

pub fn add_colstyle(&mut self, style: ColStyle) -> ColStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

source

pub fn remove_colstyle(&mut self, name: &str) -> Option<ColStyle>

Removes a style.

source

pub fn colstyle(&self, name: &str) -> Option<&ColStyle>

Returns the style.

source

pub fn colstyle_mut(&mut self, name: &str) -> Option<&mut ColStyle>

Returns the mutable style.

source

pub fn add_cellstyle(&mut self, style: CellStyle) -> CellStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

source

pub fn remove_cellstyle(&mut self, name: &str) -> Option<CellStyle>

Removes a style.

source

pub fn cellstyle(&self, name: &str) -> Option<&CellStyle>

Returns the style.

source

pub fn cellstyle_mut(&mut self, name: &str) -> Option<&mut CellStyle>

Returns the mutable style.

source

pub fn add_paragraphstyle(&mut self, style: ParagraphStyle) -> ParagraphStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

source

pub fn remove_paragraphstyle(&mut self, name: &str) -> Option<ParagraphStyle>

Removes a style.

source

pub fn paragraphstyle(&self, name: &str) -> Option<&ParagraphStyle>

Returns the style.

source

pub fn paragraphstyle_mut(&mut self, name: &str) -> Option<&mut ParagraphStyle>

Returns the mutable style.

source

pub fn add_textstyle(&mut self, style: TextStyle) -> TextStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

source

pub fn remove_textstyle(&mut self, name: &str) -> Option<TextStyle>

Removes a style.

source

pub fn textstyle(&self, name: &str) -> Option<&TextStyle>

Returns the style.

source

pub fn textstyle_mut(&mut self, name: &str) -> Option<&mut TextStyle>

Returns the mutable style.

source

pub fn add_graphicstyle(&mut self, style: GraphicStyle) -> GraphicStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

source

pub fn remove_graphicstyle(&mut self, name: &str) -> Option<GraphicStyle>

Removes a style.

source

pub fn graphicstyle(&self, name: &str) -> Option<&GraphicStyle>

Returns the style.

source

pub fn graphicstyle_mut(&mut self, name: &str) -> Option<&mut GraphicStyle>

Returns the mutable style.

source

pub fn add_boolean_format(
&mut self,
vstyle: ValueFormatBoolean
) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

source

pub fn remove_boolean_format(&mut self, name: &str) -> Option<ValueFormatBoolean>

Removes the format.

source

pub fn boolean_format(&self, name: &str) -> Option<&ValueFormatBoolean>

Returns the format.

source

pub fn boolean_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatBoolean>

Returns the mutable format.

source

pub fn add_number_format(&mut self, vstyle: ValueFormatNumber) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

source

pub fn remove_number_format(&mut self, name: &str) -> Option<ValueFormatNumber>

Removes the format.

source

pub fn number_format(&self, name: &str) -> Option<&ValueFormatBoolean>

Returns the format.

source

pub fn number_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatBoolean>

Returns the mutable format.

source

pub fn add_percentage_format(
&mut self,
vstyle: ValueFormatPercentage
) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

source

pub fn remove_percentage_format(
&mut self,
name: &str
) -> Option<ValueFormatPercentage>

Removes the format.

source

pub fn percentage_format(&self, name: &str) -> Option<&ValueFormatPercentage>

Returns the format.

source

pub fn percentage_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatPercentage>

Returns the mutable format.

source

pub fn add_currency_format(
&mut self,
vstyle: ValueFormatCurrency
) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

source

pub fn remove_currency_format(
&mut self,
name: &str
) -> Option<ValueFormatCurrency>

Removes the format.

source

pub fn currency_format(&self, name: &str) -> Option<&ValueFormatCurrency>

Returns the format.

source

pub fn currency_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatCurrency>

Returns the mutable format.

source

pub fn add_text_format(&mut self, vstyle: ValueFormatText) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

source

pub fn remove_text_format(&mut self, name: &str) -> Option<ValueFormatText>

Removes the format.

source

pub fn text_format(&self, name: &str) -> Option<&ValueFormatText>

Returns the format.

source

pub fn text_format_mut(&mut self, name: &str) -> Option<&mut ValueFormatText>

Returns the mutable format.

source

pub fn add_datetime_format(
&mut self,
vstyle: ValueFormatDateTime
) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

source

pub fn remove_datetime_format(
&mut self,
name: &str
) -> Option<ValueFormatDateTime>

Removes the format.

source

pub fn datetime_format(&self, name: &str) -> Option<&ValueFormatDateTime>

Returns the format.

source

pub fn datetime_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatDateTime>

Returns the mutable format.

source

pub fn add_timeduration_format(
&mut self,
vstyle: ValueFormatTimeDuration
) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

source

pub fn remove_timeduration_format(
&mut self,
name: &str
) -> Option<ValueFormatTimeDuration>

Removes the format.

source

pub fn timeduration_format(&self, name: &str) -> Option<&ValueFormatTimeDuration>

Returns the format.

source

pub fn timeduration_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatTimeDuration>

Returns the mutable format.

source

pub fn add_pagestyle(&mut self, pstyle: PageStyle) -> PageStyleRef

Adds a value PageStyle. Unnamed formats will be assigned an automatic name.

source

pub fn remove_pagestyle(&mut self, name: &str) -> Option<PageStyle>

Removes the PageStyle.

source

pub fn pagestyle(&self, name: &str) -> Option<&PageStyle>

Returns the PageStyle.

source

pub fn pagestyle_mut(&mut self, name: &str) -> Option<&mut PageStyle>

Returns the mutable PageStyle.

source

pub fn add_masterpage(&mut self, mpage: MasterPage) -> MasterPageRef

Adds a value MasterPage. Unnamed formats will be assigned an automatic name.

source

pub fn remove_masterpage(&mut self, name: &str) -> Option<MasterPage>

Removes the MasterPage.

source

pub fn masterpage(&self, name: &str) -> Option<&MasterPage>

Returns the MasterPage.

source

pub fn masterpage_mut(&mut self, name: &str) -> Option<&mut MasterPage>

Returns the mutable MasterPage.

source

pub fn add_validation(&mut self, valid: Validation) -> ValidationRef

Adds a Validation. Nameless validations will be assigned a name.

source

pub fn remove_validation(&mut self, name: &str) -> Option<Validation>

Removes a Validation.

source

pub fn validation(&self, name: &str) -> Option<&Validation>

Returns the Validation.

source

pub fn validation_mut(&mut self, name: &str) -> Option<&mut Validation>

Returns a mutable Validation.

Trait Implementations

source

impl Clone for WorkBook

source

fn clone(&self) -> WorkBook

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for WorkBook

source

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

Formats the value using the given formatter. Read more

source

impl Default for WorkBook

source

fn default() -> WorkBook

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for WorkBook

impl Send for WorkBook

impl Sync for WorkBook

impl Unpin for WorkBook

impl UnwindSafe for WorkBook

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> Twhere
Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> Conv for T

fn conv<T>(self) -> Twhere
Self: Into<T>,

Converts self into a target type. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pipe for Twhere
T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
 Self: Borrow,
 B: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
 Self: BorrowMut,
 B: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
 Self: AsRef,
 U: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
 Self: AsMut,
 U: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
 Self: Deref<Target = T>,
 T: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> Rwhere
 Self: DerefMut<Target = T> + Deref,
 T: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Pipe for T

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

impl<T> PipeAsRef for T

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
 Self: AsRef<T>,
 T: 'a,
 R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> Rwhere
 Self: AsMut<T>,
 T: 'a,
 R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

impl<T> PipeBorrow for T

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
 Self: Borrow<T>,
 T: 'a,
 R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

fn pipe_borrow_mut<'a, T, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut T) -> R
) -> Rwhere
 Self: BorrowMut<T>,
 T: 'a,
 R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

impl<T> PipeDeref for T

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> Rwhere
Self: Deref,
R: 'a,

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

fn pipe_deref_mut<'a, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut Self::Target) -> R
) -> Rwhere
 Self: DerefMut,
 R: 'a,

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

impl<T> PipeRef for T

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow,
B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut,
B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow,
B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut,
B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

impl<T> Tap for T

fn tap<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&Self) -> R,

Provides immutable access for inspection. Read more

fn tap_dbg<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&Self) -> R,

Calls tap in debug builds, and does nothing in release builds.

fn tap_mut<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&mut Self) -> R,

Provides mutable access for modification. Read more

fn tap_mut_dbg<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&mut Self) -> R,

Calls tap_mut in debug builds, and does nothing in release builds.

impl<T, U> TapAsRef for Twhere
U: ?Sized,

fn tap_ref<F, R>(self, func: F) -> Selfwhere
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the reference for inspection.

fn tap_ref_dbg<F, R>(self, func: F) -> Selfwhere
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Calls tap_ref in debug builds, and does nothing in release builds.

fn tap_ref_mut<F, R>(self, func: F) -> Selfwhere
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the reference for modification.

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Selfwhere
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_ref_mut in debug builds, and does nothing in release builds.

impl<T, U> TapBorrow for Twhere
U: ?Sized,

fn tap_borrow<F, R>(self, func: F) -> Selfwhere
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the borrow for inspection. Read more

fn tap_borrow_dbg<F, R>(self, func: F) -> Selfwhere
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Calls tap_borrow in debug builds, and does nothing in release builds.

fn tap_borrow_mut<F, R>(self, func: F) -> Selfwhere
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the borrow for modification.

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Selfwhere
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_borrow_mut in debug builds, and does nothing in release builds. Read more

impl<T> TapDeref for T

fn tap_deref<F, R>(self, func: F) -> Selfwhere
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Immutably dereferences self for inspection.

fn tap_deref_dbg<F, R>(self, func: F) -> Selfwhere
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Calls tap_deref in debug builds, and does nothing in release builds.

fn tap_deref_mut<F, R>(self, func: F) -> Selfwhere
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Mutably dereferences self for modification.

fn tap_deref_mut_dbg<F, R>(self, func: F) -> Selfwhere
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Calls tap_deref_mut in debug builds, and does nothing in release builds. Read more

source

impl<T> ToOwned for Twhere
T: Clone,

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

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>where
Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>where
Self: TryInto<T>,

Attempts to convert self into a target type. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct spreadsheet_ods::WorkBook

Implementations

impl WorkBook

pub fn new_empty() -> Self

pub fn new(locale: Locale) -> Self

pub fn locale_settings(&mut self, locale: Locale)

pub fn version(&self) -> &String

pub fn set_version(&mut self, version: String)

pub fn config(&self) -> &WorkBookConfig

pub fn config_mut(&mut self) -> &mut WorkBookConfig

pub fn num_sheets(&self) -> usize

pub fn sheet_idx<S: AsRef<str>>(&self, name: S) -> Option<usize>

pub fn detach_sheet(&mut self, n: usize) -> Detached<usize, Sheet>

pub fn attach_sheet(&mut self, sheet: Detached<usize, Sheet>)

pub fn sheet(&self, n: usize) -> &Sheet

pub fn sheet_mut(&mut self, n: usize) -> &mut Sheet

pub fn insert_sheet(&mut self, i: usize, sheet: Sheet)

pub fn push_sheet(&mut self, sheet: Sheet)

pub fn remove_sheet(&mut self, n: usize) -> Sheet

pub fn add_def_style(&mut self, value_type: ValueType, style: &CellStyleRef)

pub fn def_style(&self, value_type: ValueType) -> Option<&String>

pub fn add_font(&mut self, font: FontFaceDecl)

pub fn remove_font(&mut self, name: &str) -> Option<FontFaceDecl>

pub fn font(&self, name: &str) -> Option<&FontFaceDecl>

pub fn font_mut(&mut self, name: &str) -> Option<&mut FontFaceDecl>

pub fn add_tablestyle(&mut self, style: TableStyle) -> TableStyleRef

pub fn remove_tablestyle(&mut self, name: &str) -> Option<TableStyle>

pub fn tablestyle(&self, name: &str) -> Option<&TableStyle>

pub fn tablestyle_mut(&mut self, name: &str) -> Option<&mut TableStyle>

pub fn add_rowstyle(&mut self, style: RowStyle) -> RowStyleRef

pub fn remove_rowstyle(&mut self, name: &str) -> Option<RowStyle>

pub fn rowstyle(&self, name: &str) -> Option<&RowStyle>

pub fn rowstyle_mut(&mut self, name: &str) -> Option<&mut RowStyle>

pub fn add_colstyle(&mut self, style: ColStyle) -> ColStyleRef

pub fn remove_colstyle(&mut self, name: &str) -> Option<ColStyle>

pub fn colstyle(&self, name: &str) -> Option<&ColStyle>

pub fn colstyle_mut(&mut self, name: &str) -> Option<&mut ColStyle>

pub fn add_cellstyle(&mut self, style: CellStyle) -> CellStyleRef

pub fn remove_cellstyle(&mut self, name: &str) -> Option<CellStyle>

pub fn cellstyle(&self, name: &str) -> Option<&CellStyle>

pub fn cellstyle_mut(&mut self, name: &str) -> Option<&mut CellStyle>

pub fn add_paragraphstyle(&mut self, style: ParagraphStyle) -> ParagraphStyleRef

pub fn remove_paragraphstyle(&mut self, name: &str) -> Option<ParagraphStyle>

pub fn paragraphstyle(&self, name: &str) -> Option<&ParagraphStyle>

pub fn paragraphstyle_mut(&mut self, name: &str) -> Option<&mut ParagraphStyle>

pub fn add_textstyle(&mut self, style: TextStyle) -> TextStyleRef

pub fn remove_textstyle(&mut self, name: &str) -> Option<TextStyle>

pub fn textstyle(&self, name: &str) -> Option<&TextStyle>

pub fn textstyle_mut(&mut self, name: &str) -> Option<&mut TextStyle>

pub fn add_graphicstyle(&mut self, style: GraphicStyle) -> GraphicStyleRef

pub fn remove_graphicstyle(&mut self, name: &str) -> Option<GraphicStyle>

pub fn graphicstyle(&self, name: &str) -> Option<&GraphicStyle>

pub fn graphicstyle_mut(&mut self, name: &str) -> Option<&mut GraphicStyle>

pub fn add_boolean_format( &mut self, vstyle: ValueFormatBoolean) -> ValueFormatRef

pub fn remove_boolean_format(&mut self, name: &str) -> Option<ValueFormatBoolean>

pub fn boolean_format(&self, name: &str) -> Option<&ValueFormatBoolean>

pub fn boolean_format_mut( &mut self, name: &str) -> Option<&mut ValueFormatBoolean>

pub fn add_number_format(&mut self, vstyle: ValueFormatNumber) -> ValueFormatRef

pub fn remove_number_format(&mut self, name: &str) -> Option<ValueFormatNumber>

pub fn number_format(&self, name: &str) -> Option<&ValueFormatBoolean>

pub fn number_format_mut( &mut self, name: &str) -> Option<&mut ValueFormatBoolean>

pub fn add_percentage_format( &mut self, vstyle: ValueFormatPercentage) -> ValueFormatRef

pub fn remove_percentage_format( &mut self, name: &str) -> Option<ValueFormatPercentage>

pub fn percentage_format(&self, name: &str) -> Option<&ValueFormatPercentage>

pub fn percentage_format_mut( &mut self, name: &str) -> Option<&mut ValueFormatPercentage>

pub fn add_currency_format( &mut self, vstyle: ValueFormatCurrency) -> ValueFormatRef

pub fn remove_currency_format( &mut self, name: &str) -> Option<ValueFormatCurrency>

pub fn currency_format(&self, name: &str) -> Option<&ValueFormatCurrency>

pub fn currency_format_mut( &mut self, name: &str) -> Option<&mut ValueFormatCurrency>

pub fn add_text_format(&mut self, vstyle: ValueFormatText) -> ValueFormatRef

pub fn remove_text_format(&mut self, name: &str) -> Option<ValueFormatText>

pub fn text_format(&self, name: &str) -> Option<&ValueFormatText>

pub fn text_format_mut(&mut self, name: &str) -> Option<&mut ValueFormatText>

pub fn add_datetime_format( &mut self, vstyle: ValueFormatDateTime) -> ValueFormatRef

pub fn remove_datetime_format( &mut self, name: &str) -> Option<ValueFormatDateTime>

pub fn datetime_format(&self, name: &str) -> Option<&ValueFormatDateTime>

pub fn datetime_format_mut( &mut self, name: &str) -> Option<&mut ValueFormatDateTime>

pub fn add_timeduration_format( &mut self, vstyle: ValueFormatTimeDuration) -> ValueFormatRef

pub fn remove_timeduration_format( &mut self, name: &str) -> Option<ValueFormatTimeDuration>

pub fn timeduration_format(&self, name: &str) -> Option<&ValueFormatTimeDuration>

pub fn add_boolean_format(
&mut self,
vstyle: ValueFormatBoolean
) -> ValueFormatRef

pub fn boolean_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatBoolean>

pub fn number_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatBoolean>

pub fn add_percentage_format(
&mut self,
vstyle: ValueFormatPercentage
) -> ValueFormatRef

pub fn remove_percentage_format(
&mut self,
name: &str
) -> Option<ValueFormatPercentage>

pub fn percentage_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatPercentage>

pub fn add_currency_format(
&mut self,
vstyle: ValueFormatCurrency
) -> ValueFormatRef

pub fn remove_currency_format(
&mut self,
name: &str
) -> Option<ValueFormatCurrency>

pub fn currency_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatCurrency>

pub fn add_datetime_format(
&mut self,
vstyle: ValueFormatDateTime
) -> ValueFormatRef

pub fn remove_datetime_format(
&mut self,
name: &str
) -> Option<ValueFormatDateTime>

pub fn datetime_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatDateTime>

pub fn add_timeduration_format(
&mut self,
vstyle: ValueFormatTimeDuration
) -> ValueFormatRef

pub fn remove_timeduration_format(
&mut self,
name: &str
) -> Option<ValueFormatTimeDuration>

pub fn timeduration_format_mut(
&mut self,
name: &str
) -> Option<&mut ValueFormatTimeDuration>

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

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

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

fn conv<T>(self) -> Twhere
Self: Into<T>,

fn conv<T>(self) -> Twhere
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,

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

impl<T> Pipe for Twhere
T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,

fn pipe_deref_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> Rwhere
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,