Struct Doc

pub struct Doc {

    pub browser_link: String,
    pub created_at: DateTime<Utc>,
    pub doc_size: Option<DocSize>,
    pub folder: FolderReference,
    pub folder_id: String,
    pub href: String,
    pub icon: Option<Icon>,
    pub id: String,
    pub name: String,
    pub owner: String,
    pub owner_name: String,
    pub published: Option<DocPublished>,
    pub source_doc: Option<DocSourceDoc>,
    pub type_: DocType,
    pub updated_at: DateTime<Utc>,
    pub workspace: WorkspaceReference,
    pub workspace_id: String,
}

Metadata about a Coda doc.

JSON schema

{
 "description": "Metadata about a Coda doc.",
 "type": "object",
 "required": [
   "browserLink",
   "createdAt",
   "folder",
   "folderId",
   "href",
   "id",
   "name",
   "owner",
   "ownerName",
   "type",
   "updatedAt",
   "workspace",
   "workspaceId"
 ],
 "properties": {
   "browserLink": {
     "description": "Browser-friendly link to the Coda doc.",
     "examples": [
       "https://coda.io/d/_dAbCDeFGH"
     ],
     "type": "string",
     "format": "url"
   },
   "createdAt": {
     "description": "Timestamp for when the doc was created.",
     "examples": [
       "2018-04-11T00:18:57.946Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "docSize": {
     "$ref": "#/components/schemas/DocSize"
   },
   "folder": {
     "$ref": "#/components/schemas/FolderReference"
   },
   "folderId": {
     "description": "ID of the Coda folder containing this doc.",
     "deprecated": true,
     "examples": [
       "fl-1Ab234"
     ],
     "type": "string"
   },
   "href": {
     "description": "API link to the Coda doc.",
     "examples": [
       "https://coda.io/apis/v1/docs/AbCDeFGH"
     ],
     "type": "string",
     "format": "url"
   },
   "icon": {
     "$ref": "#/components/schemas/Icon"
   },
   "id": {
     "description": "ID of the Coda doc.",
     "examples": [
       "AbCDeFGH"
     ],
     "type": "string"
   },
   "name": {
     "description": "Name of the doc.",
     "examples": [
       "Product Launch Hub"
     ],
     "type": "string"
   },
   "owner": {
     "description": "Email address of the doc owner.",
     "examples": [
       "user@example.com"
     ],
     "type": "string",
     "format": "email"
   },
   "ownerName": {
     "description": "Name of the doc owner.",
     "examples": [
       "Some User"
     ],
     "type": "string"
   },
   "published": {
     "$ref": "#/components/schemas/DocPublished"
   },
   "sourceDoc": {
     "allOf": [
       {
         "description": "Reference to a Coda doc from which this doc was
copied, if any.",
         "type": "object",
         "additionalProperties": false
       },
       {
         "$ref": "#/components/schemas/DocReference"
       }
     ]
   },
   "type": {
     "description": "The type of this resource.",
     "type": "string",
     "enum": [
       "doc"
     ],
     "x-tsType": "Type.Doc"
   },
   "updatedAt": {
     "description": "Timestamp for when the doc was last modified.",
     "examples": [
       "2018-04-11T00:18:57.946Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "workspace": {
     "$ref": "#/components/schemas/WorkspaceReference"
   },
   "workspaceId": {
     "description": "ID of the Coda workspace containing this doc.",
     "deprecated": true,
     "examples": [
       "ws-1Ab234"
     ],
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "Doc"
}

Fields

browser_link: String

Browser-friendly link to the Coda doc.

created_at: DateTime<Utc>

Timestamp for when the doc was created.

doc_size: Option<DocSize>

folder: FolderReference

folder_id: String

ID of the Coda folder containing this doc.

href: String

API link to the Coda doc.

icon: Option<Icon>

id: String

ID of the Coda doc.

name: String

Name of the doc.

owner: String

Email address of the doc owner.

owner_name: String

Name of the doc owner.

published: Option<DocPublished>

source_doc: Option<DocSourceDoc>

type_: DocType

The type of this resource.

updated_at: DateTime<Utc>

Timestamp for when the doc was last modified.

workspace: WorkspaceReference

workspace_id: String

ID of the Coda workspace containing this doc.

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Doc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Doc> for Doc

fn from(value: &Doc) -> Self

Converts to this type from the input type.

impl Serialize for Doc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.