Struct umya_spreadsheet::structs::Spreadsheet

source · [−]

pub struct Spreadsheet { /* private fields */ }

Expand description

A Spreadsheet Object. The starting point of all struct.

Implementations

source

impl Spreadsheet

source

pub fn insert_new_row<S: Into<String>>(
 &mut self,
 sheet_name: S,
 row_index: u32,
 num_rows: u32
)

Insert new rows.

Arguments

sheet_name - Specify the sheet name. ex) “Sheet1”
row_index - Specify point of insert. ex) 1
num_rows - Specify number to insert. ex) 2

Examples

let mut book = umya_spreadsheet::new_file();
book.insert_new_row("Sheet1", 2, 3);

source

pub fn insert_new_colmun<S: Into<String>>(
 &mut self,
 sheet_name: S,
 column: S,
 num_columns: u32
)

Insert new colmuns.

Arguments

sheet_name - Specify the sheet name. ex) “Sheet1”
column - Specify point of insert. ex) “B”
num_columns - Specify number to insert. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.insert_new_colmun("Sheet1", "B", 3);

source

pub fn insert_new_colmun_by_index<S: Into<String>>(
 &mut self,
 sheet_name: S,
 column_index: u32,
 num_columns: u32
)

Insert new colmuns.

Arguments

sheet_name - Specify the sheet name. ex) “Sheet1”
column_index - Specify point of insert. ex) 2
num_columns - Specify number to insert. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.insert_new_colmun_by_index("Sheet1", 2, 3);

source

pub fn remove_row<S: Into<String>>(
 &mut self,
 sheet_name: S,
 row_index: u32,
 num_rows: u32
)

Remove rows.

Arguments

sheet_name - Specify the sheet name. ex) “Sheet1”
row_index - Specify point of remove. ex) 1
num_rows - Specify number to remove. ex) 2

Examples

let mut book = umya_spreadsheet::new_file();
book.remove_row("Sheet1", 2, 3);

source

pub fn remove_colmun<S: Into<String>>(
 &mut self,
 sheet_name: S,
 column: S,
 num_columns: u32
)

Remove colmuns.

Arguments

sheet_name - Specify the sheet name. ex) “Sheet1”
column - Specify point of remove. ex) “B”
num_columns - Specify number to remove. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.remove_colmun("Sheet1", "B", 3);

source

pub fn remove_colmun_by_index<S: Into<String>>(
 &mut self,
 sheet_name: S,
 column_index: u32,
 num_columns: u32
)

Remove colmuns.

Arguments

sheet_name - Specify the sheet name. ex) “Sheet1”
column_index - Specify point of remove. ex) 2
num_columns - Specify number to remove. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.remove_colmun_by_index("Sheet1", 2, 3);

source

pub fn get_cell_value_by_address<S: Into<String>>(
 &self,
 address: S
) -> Vec<&CellValue>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Gets the cell value by specifying an address.

Arguments

address - address. ex) “Sheet1!A1:C5”

Return value

*Vec<&CellValue> - CellValue List.

Examples

let mut book = umya_spreadsheet::new_file();
let mut cell_value_List = book.get_cell_value_by_address("Sheet1!A1:C5");

source

pub fn get_theme(&self) -> &Theme

Get Theme.

source

pub fn get_theme_mut(&mut self) -> &mut Theme

Get Theme in mutable.

source

pub fn set_theme(&mut self, value: Theme) -> &mut Self

Set Theme.

Arguments

value - Theme

source

pub fn get_properties(&self) -> &Properties

Get Properties.

source

pub fn get_properties_mut(&mut self) -> &mut Properties

Get Properties in mutable.

source

pub fn set_properties(&mut self, value: Properties) -> &mut Self

Set Properties.

Arguments

value - Properties

source

pub fn get_security(&self) -> &Security

Get Security.

source

pub fn get_security_mut(&mut self) -> &mut Security

Get Security in mutable.

source

pub fn set_security(&mut self, value: Security) -> &mut Self

Set Security.

Arguments

value - Security

source

pub fn get_macros_code(&self) -> &Option<Vec<u8>>

Get Macros Code.

Return value

&Option<Vec<u8>> - Macros Code Raw Data.

source

pub fn set_macros_code(&mut self, value: Vec<u8>) -> &mut Self

Set Macros Code.

Arguments

value - Macros Code Raw Data.

source

pub fn remove_macros_code(&mut self) -> &mut Self

Remove Macros Code

source

pub fn get_has_macros(&self) -> bool

Has Macros Code

source

pub fn get_sheet_collection(&self) -> &Vec<Worksheet>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get Work Sheet List.

source

pub fn get_sheet_collection_no_check(&self) -> &Vec<Worksheet>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get Work Sheet List. No check serialized.

source

pub fn get_sheet_collection_mut(&mut self) -> &mut Vec<Worksheet>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get Work Sheet List in mutable.

source

pub fn get_sheet_count(&self) -> usize

Get Work Sheet Count.

Return value

usize - Work Sheet Count.

source

pub fn read_sheet_collection(&mut self) -> &mut Self

serialize by all worksheet.

source

pub fn read_sheet(&mut self, index: usize) -> &mut Self

serialize a worksheet.

source

pub fn get_sheet(&self, index: usize) -> Result<&Worksheet, &'static str>

Get Work Sheet.

Arguments

index - sheet index

Return value

Result<&Worksheet, &'static str> - OK:work sheet. Err:Error.

source

pub fn get_sheet_mut(&mut self, index: usize) -> &mut Worksheet

Get Work Sheet in mutable.

Arguments

index - sheet index

Return value

&mut Worksheet - Work sheet.

source

pub fn get_sheet_by_name<S: Into<String>>(
&self,
sheet_name: S
) -> Result<&Worksheet, &'static str>

Get Work Sheet.

Arguments

sheet_name - sheet name

Return value

Result<&Worksheet, &'static str> - OK:work sheet. Err:Error.

source

pub fn get_sheet_by_name_mut<S: Into<String>>(
&mut self,
sheet_name: S
) -> Result<&mut Worksheet, &'static str>

Get Work Sheet in mutable.

Arguments

sheet_name - sheet name

Return value

Result<&mut Worksheet, &'static str> - OK:work sheet. Err:Error.

source

pub fn add_sheet(
&mut self,
value: Worksheet
) -> Result<&mut Worksheet, &'static str>

Add Work Sheet.

Arguments

value - Work Sheet

Return value

Result<&mut Worksheet, &'static str> - OK:added work sheet. Err:Error.

source

pub fn new_sheet<S: Into<String>>(
&mut self,
sheet_title: S
) -> Result<&mut Worksheet, &'static str>

Add New Work Sheet.

Arguments

sheet_title - sheet title

Return value

Result<&mut Worksheet, &'static str> - OK:added work sheet. Err:Error.

source

pub fn set_sheet_title<S: Into<String>>(
 &mut self,
 index: usize,
 sheet_title: S
) -> Result<(), &'static str>

Set Sheet Title.

Arguments

index - target sheet index
sheet_title - sheet title

Return value

Result<(), &'static str> - OK:Success Err:Error.

source

pub fn get_workbook_view(&self) -> &WorkbookView

Get Workbook View.

source

pub fn get_workbook_view_mut(&mut self) -> &mut WorkbookView

Get Workbook View in mutable.

source

pub fn set_workbook_view(&mut self, value: WorkbookView) -> &mut Self

Set Workbook View.

Arguments

value - WorkbookView

source

pub fn get_image_collection(&self) -> Vec<&Image>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Outputs all images contained in the spreadsheet.

Return value

Vec<&Image> - Image Object List.

Trait Implementations

source

impl Clone for Spreadsheet

source

fn clone(&self) -> Spreadsheet

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 Spreadsheet

source

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

Formats the value using the given formatter. Read more

source

impl Default for Spreadsheet

source

fn default() -> Spreadsheet

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

Auto Trait Implementations

impl RefUnwindSafe for Spreadsheet

impl Send for Spreadsheet

impl Sync for Spreadsheet

impl Unpin for Spreadsheet

impl UnwindSafe for Spreadsheet

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. 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 T where
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.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T, U> TryFrom for T where
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 T where
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 umya_spreadsheet::structs::Spreadsheet

Implementations

impl Spreadsheet

pub fn insert_new_row<S: Into<String>>( &mut self, sheet_name: S, row_index: u32, num_rows: u32)

pub fn insert_new_colmun<S: Into<String>>( &mut self, sheet_name: S, column: S, num_columns: u32)

pub fn insert_new_colmun_by_index<S: Into<String>>( &mut self, sheet_name: S, column_index: u32, num_columns: u32)

pub fn remove_row<S: Into<String>>( &mut self, sheet_name: S, row_index: u32, num_rows: u32)

pub fn remove_colmun<S: Into<String>>( &mut self, sheet_name: S, column: S, num_columns: u32)

pub fn remove_colmun_by_index<S: Into<String>>( &mut self, sheet_name: S, column_index: u32, num_columns: u32)

pub fn get_cell_value_by_address<S: Into<String>>( &self, address: S) -> Vec<&CellValue>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_theme(&self) -> &Theme

pub fn get_theme_mut(&mut self) -> &mut Theme

pub fn set_theme(&mut self, value: Theme) -> &mut Self

pub fn get_properties(&self) -> &Properties

pub fn get_properties_mut(&mut self) -> &mut Properties

pub fn set_properties(&mut self, value: Properties) -> &mut Self

pub fn get_security(&self) -> &Security

pub fn get_security_mut(&mut self) -> &mut Security

pub fn set_security(&mut self, value: Security) -> &mut Self

pub fn get_macros_code(&self) -> &Option<Vec<u8>>

pub fn set_macros_code(&mut self, value: Vec<u8>) -> &mut Self

pub fn remove_macros_code(&mut self) -> &mut Self

pub fn get_has_macros(&self) -> bool

pub fn get_sheet_collection(&self) -> &Vec<Worksheet>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_sheet_collection_no_check(&self) -> &Vec<Worksheet>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_sheet_collection_mut(&mut self) -> &mut Vec<Worksheet>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_sheet_count(&self) -> usize

pub fn read_sheet_collection(&mut self) -> &mut Self

pub fn read_sheet(&mut self, index: usize) -> &mut Self

pub fn get_sheet(&self, index: usize) -> Result<&Worksheet, &'static str>

pub fn get_sheet_mut(&mut self, index: usize) -> &mut Worksheet

pub fn get_sheet_by_name<S: Into<String>>( &self, sheet_name: S) -> Result<&Worksheet, &'static str>

pub fn get_sheet_by_name_mut<S: Into<String>>( &mut self, sheet_name: S) -> Result<&mut Worksheet, &'static str>

pub fn add_sheet( &mut self, value: Worksheet) -> Result<&mut Worksheet, &'static str>

pub fn new_sheet<S: Into<String>>( &mut self, sheet_title: S) -> Result<&mut Worksheet, &'static str>

pub fn set_sheet_title<S: Into<String>>( &mut self, index: usize, sheet_title: S) -> Result<(), &'static str>

pub fn get_workbook_view(&self) -> &WorkbookView

pub fn get_workbook_view_mut(&mut self) -> &mut WorkbookView

pub fn set_workbook_view(&mut self, value: WorkbookView) -> &mut Self

pub fn get_image_collection(&self) -> Vec<&Image>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

Trait Implementations

impl Clone for Spreadsheet

fn clone(&self) -> Spreadsheet

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

impl Debug for Spreadsheet

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

impl Default for Spreadsheet

fn default() -> Spreadsheet

Auto Trait Implementations

impl RefUnwindSafe for Spreadsheet

impl Send for Spreadsheet

impl Sync for Spreadsheet

impl Unpin for Spreadsheet

impl UnwindSafe for Spreadsheet

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

pub fn insert_new_row<S: Into<String>>(
&mut self,
sheet_name: S,
row_index: u32,
num_rows: u32
)

pub fn insert_new_colmun<S: Into<String>>(
&mut self,
sheet_name: S,
column: S,
num_columns: u32
)

pub fn insert_new_colmun_by_index<S: Into<String>>(
&mut self,
sheet_name: S,
column_index: u32,
num_columns: u32
)

pub fn remove_row<S: Into<String>>(
&mut self,
sheet_name: S,
row_index: u32,
num_rows: u32
)

pub fn remove_colmun<S: Into<String>>(
&mut self,
sheet_name: S,
column: S,
num_columns: u32
)

pub fn remove_colmun_by_index<S: Into<String>>(
&mut self,
sheet_name: S,
column_index: u32,
num_columns: u32
)

pub fn get_cell_value_by_address<S: Into<String>>(
&self,
address: S
) -> Vec<&CellValue>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get_sheet_collection(&self) -> &Vec<Worksheet>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get_sheet_collection_no_check(&self) -> &Vec<Worksheet>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get_sheet_collection_mut(&mut self) -> &mut Vec<Worksheet>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get_sheet_by_name<S: Into<String>>(
&self,
sheet_name: S
) -> Result<&Worksheet, &'static str>

pub fn get_sheet_by_name_mut<S: Into<String>>(
&mut self,
sheet_name: S
) -> Result<&mut Worksheet, &'static str>

pub fn add_sheet(
&mut self,
value: Worksheet
) -> Result<&mut Worksheet, &'static str>

pub fn new_sheet<S: Into<String>>(
&mut self,
sheet_title: S
) -> Result<&mut Worksheet, &'static str>

pub fn set_sheet_title<S: Into<String>>(
&mut self,
index: usize,
sheet_title: S
) -> Result<(), &'static str>

pub fn get_image_collection(&self) -> Vec<&Image>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

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

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

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

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

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

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