Struct Row

pub struct Row {

    pub id: u64,
    pub sheet_id: Option<u64>,
    pub access_level: Option<AccessLevel>,
    pub attachments: Option<Vec<AttachmentMeta>>,
    pub cells: Vec<Cell>,
    pub columns: Vec<Column>,
    pub conditional_format: Option<String>,
    pub created_at: String,
    pub created_by: Option<User>,
    pub discussions: Option<Vec<Discussion>>,
    pub expanded: Option<bool>,
    pub filtered_out: Option<bool>,
    pub format: Option<String>,
    pub in_critical_path: Option<bool>,
    pub locked: Option<bool>,
    pub locked_for_user: Option<bool>,
    pub modified_at: String,
    pub modified_by: Option<User>,
    pub permalink: Option<String>,
    pub row_number: u64,
    pub version: Option<u64>,
    pub sibling_id: Option<u64>,
    pub parent_id: Option<u64>,
    pub to_top: Option<bool>,
    pub to_bottom: Option<bool>,
    pub indent: Option<IndentEnabled>,
    pub outdent: Option<IndentEnabled>,
}

Fields

id: u64

Row Id

sheet_id: Option<u64>

Parent Sheet Id

access_level: Option<AccessLevel>

Enum: ADMIN, EDITOR, EDITOR_SHARE, OWNER, VIEWER

attachments: Option<Vec<AttachmentMeta>>

Attachments on row. Only returned if the include query string parameter contains attachments.

cells: Vec<Cell>

Cells belonging to the row.

columns: Vec<Column>

Columns of row. Only returned if the include query string parameter contains columns.

conditional_format: Option<String>

Describes this row’s conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.

created_at: String

string or number

created_by: Option<User>

User object containing name and email of the creator of this row.

discussions: Option<Vec<Discussion>>

Discussions on the row. Only returned if the include query string parameter contains discussions.

expanded: Option<bool>

Indicates whether the row is expanded or collapsed.

filtered_out: Option<bool>

Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.

format: Option<String>

Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.

in_critical_path: Option<bool>

Only returned, with a value of true, if the sheet is a project sheet with dependencies enabled and this row is in the critical path.

locked: Option<bool>

Indicates whether the row is locked.

locked_for_user: Option<bool>

Indicates whether the row is locked for the requesting user.

modified_at: String

string or number

modified_by: Option<User>

User object containing name and email of the last person to modify this row.

permalink: Option<String>

URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.

row_number: u64

Row number within the sheet.

version: Option<u64>

Sheet version number that is incremented every time a sheet is modified.

sibling_id: Option<u64>

Note

The following are used in the Row Location specified attributes.

Sibling Row Id

Also used to specify row location when adding/updating rows.

parent_id: Option<u64>

Parent Id, used to specify row location when adding/updating rows.

to_top: Option<bool>

Row Location Specifier: Top of a sheet

to_bottom: Option<bool>

Row Location Specifier: Bottom of a sheet

indent: Option<IndentEnabled>

Row Location Specifier: Indent one existing row, must have a value of “1”

outdent: Option<IndentEnabled>

Row Location Specifier: Outdent one existing row, must have a value of “1”

Implementations

impl Row

pub fn with_cells<C: Into<Vec<Cell>>>(cells: C) -> Self

pub fn with_id_and_cells<C: Into<Vec<Cell>>>(row_id: u64, cells: C) -> Self

pub fn with_id_and_cells_slice<const N: usize>( row_id: u64, cells: &[Cell; N], ) -> Self

pub fn get_cell_by_id( &self, column_id: u64, ) -> Result<&Cell, Box<dyn Error + Send + Sync>>

Retrieve a specified Cell - for a given column id - from the Row

pub fn id(self, id: u64) -> Self

Fluent setter for the id attribute (Row Id)

pub fn expanded<B: Into<Option<bool>>>(self, expanded: B) -> Self

Fluent setter for the expanded attribute

pub fn format<S: Into<String>>(self, format: S) -> Self

Fluent setter for the format attribute

pub fn locked<B: Into<Option<bool>>>(self, locked: B) -> Self

Fluent setter for the locked attribute

pub fn sibling_id<U: Into<Option<u64>>>(self, sibling_id: U) -> Self

Fluent setter for the sibling_id attribute

pub fn parent_id<U: Into<Option<u64>>>(self, parent_id: U) -> Self

Fluent setter for the parent_id attribute

pub fn to_top<B: Into<Option<bool>>>(self, to_top: B) -> Self

Fluent setter for the to_top attribute

pub fn to_bottom<B: Into<Option<bool>>>(self, to_bottom: B) -> Self

Fluent setter for the to_bottom attribute

pub fn indent<I: Into<Option<IndentEnabled>>>(self, indent: I) -> Self

Fluent setter for the indent attribute

pub fn outdent<I: Into<Option<IndentEnabled>>>(self, outdent: I) -> Self

Fluent setter for the outdent attribute

Trait Implementations

impl Clone for Row

fn clone(&self) -> Row

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Row

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

Formats the value using the given formatter.

impl Default for Row

fn default() -> Row

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Row

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> From<&[Cell; N]> for Row

fn from(cells: &[Cell; N]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Row> for ColumnMapper<'a>

fn from(row_ref: &'a Row) -> Self

Converts to this type from the input type.

impl From<Row> for Vec<Row>

fn from(row: Row) -> Self

Useful when adding / updating row(s) to a sheet.

impl From<Vec<Cell>> for Row

fn from(cells: Vec<Cell>) -> Self

Converts to this type from the input type.

impl PartialEq for Row

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

Tests for self and other values to be equal, and is used by ==.

const 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 Serialize for Row

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 Row