Enum File

pub enum File {
    External(ExternalFile),
    Uploaded(UploadedFile),
}

Note: The Notion API does not support file uploads. Therefore, for creating or updating, you are only allowed to specify an external URL using the ExternalFile variant of the enum.

https://developers.notion.com/reference/file-object

File

File objects contain data about a file that is uploaded to Notion, or data about an external file that is linked to in Notion.

When a link to an external file is set, it becomes an object like the one shown below.

{
    "name": "https://www.notion.so/images/favicon.ico",
    "type": "external",
    "external": {
        "url": "https://www.notion.so/images/favicon.ico"
    }
}

When a file is uploaded to Notion, it becomes an object as shown below.

{
    "name": "Project Alpha blueprint",
    "type": "file",
    "file": {
        "url": "https://prod-files-secure.s3.us-west-2.amazonaws.com/daa95f86-2d56-4e18-be3b-16d81b31dc0d",
        "expiry_time": "2024-04-04T10:45:54.308Z"
    }
}

Variants

External(ExternalFile)

Uploaded(UploadedFile)

Implementations

impl File

pub fn get_url(&self) -> String

This utility returns the URL regardless of whether the File variant is External or Uploaded. (You can retrieve the URL without having to check the variant).

pub fn name<T>(self, name: T) -> Self

where T: AsRef<str>,

This function can only be used if the File variant is External. If the File variant is Uploaded, it returns Self without changing the value.

pub fn caption(self, caption: Vec<RichText>) -> Self

This function can only be used if the File variant is External. If the File variant is Uploaded, it returns Self without changing the value.

pub fn url<T>(self, url: T) -> Self

where T: AsRef<str>,

This function can only be used if the File variant is External. If the File variant is Uploaded, it returns Self without changing the value.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for File

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for File

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

Formats the value using the given formatter.

impl From<File> for PageFilesProperty

fn from(value: File) -> Self

Converts to this type from the input type.

impl PartialEq for File

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

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

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 File

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for File

impl StructuralPartialEq for File