Struct FileConfig

pub struct FileConfig {
    pub path: PathBuf,
    pub create_directory_all: bool,
    pub overwrite_existing_file: bool,
    pub file_name: Option<OsString>,
    pub extension: Option<OsString>,
}

Config for downloading files using Microsoft Graph File and OneDrive APIs. FileConfig can also be used for uploads but all fields except for the provided path are ignored.

Example

use std::ffi::{OsStr, OsString};
use std::path::Path;
use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .file_name(OsStr::new("example.json"));

Example

use std::ffi::{OsStr, OsString};
use std::path::Path;
use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .overwrite_existing_file(true)
    .extension(OsStr::new("pdf"));

Fields

path: PathBuf

create_directory_all: bool

Used only when downloading files. Default is true.

overwrite_existing_file: bool

Used only when downloading files

file_name: Option<OsString>

Used only when downloading files

extension: Option<OsString>

Used only when downloading files

Implementations

impl FileConfig

pub fn new<P: AsRef<Path>>(path: P) -> FileConfig

Create the file configuration for downloading files.

Example

use std::ffi::{OsStr, OsString};
use std::path::Path;
use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .create_directories(true)
    .file_name(OsStr::new("example.json"));

Example

use std::ffi::{OsStr, OsString};
use std::path::Path;
use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .overwrite_existing_file(true)
    .extension(OsStr::new("pdf"));

pub fn create_directories(self, create_directories: bool) -> FileConfig

Create all directories in the path given if they do not exist.

Example

use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .create_directories(true);

pub fn overwrite_existing_file(self, overwrite_file: bool) -> FileConfig

Overwrite an existing file of the same file name and path. This is true by default.

Example

use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .overwrite_existing_file(true);

pub fn file_name(self, file_name: &OsStr) -> FileConfig

Set the file name and extension. If you use the format ODataQuery to change the file type such as from JSON to PDF then you must provide a name for the file or the download will fail.

Example

use std::ffi::{OsStr, OsString};
use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .file_name(OsStr::new("example.pdf"));

pub fn extension(self, ext: &OsStr) -> FileConfig

Set the extension of the file being downloaded. This only changes the extension name of the file and does not change the format of the file. You can change the format of the file using the ODataQuery format method such as changing from JSONto PDF

Example

use std::ffi::{OsStr, OsString};
use graph_http::api_impl::FileConfig;

let config = FileConfig::new("./examples")
    .extension(OsStr::new("pdf"));

pub fn set_path<P: AsRef<Path>>(&mut self, path: P)

Create all directories in the path if they do not exist.

Example

use std::path::Path;
use graph_http::api_impl::FileConfig;

let mut config = FileConfig::default();
config.set_path("./examples");

pub fn set_create_directories(&mut self, create_directories: bool)

Create all directories in the path given if they do not exist.

Example

use graph_http::api_impl::FileConfig;

let mut config = FileConfig::new("./examples");
config.set_create_directories(true);

pub fn set_overwrite_existing_file(&mut self, overwrite_file: bool)

Overwrite an existing file of the same file name and path.

Example

use graph_http::api_impl::FileConfig;

let mut config = FileConfig::new("./examples");
config.set_overwrite_existing_file(true);

pub fn set_file_name(&mut self, file_name: &OsStr)

Set the file name and extension. If you use the format ODataQuery to change the file type such as from JSON to PDF then you must provide a name for the file or the download will fail.

Example

use std::ffi::{OsStr, OsString};
use graph_http::api_impl::FileConfig;

let mut config = FileConfig::new("./examples");
config.set_file_name(OsStr::new("example.pdf"));

pub fn set_extension(&mut self, ext: &OsStr)

Set the extension of the file being downloaded. This only changes the extension name of the file and does not change the format of the file. You can change the format of the file using the ODataQuery format method such as changing from JSONto PDF

Example

use std::ffi::{OsStr, OsString};
use graph_http::api_impl::FileConfig;

let mut config = FileConfig::new("./examples")
    .extension(OsStr::new("pdf"));

Trait Implementations

impl BodyExt for &FileConfig

fn into_body(self) -> GraphResult<BodyRead>

impl Clone for FileConfig

fn clone(&self) -> FileConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileConfig

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

Formats the value using the given formatter.

impl Default for FileConfig

fn default() -> FileConfig

Returns the “default value” for a type.

impl From<&Path> for FileConfig

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<PathBuf> for FileConfig

fn from(path_buf: PathBuf) -> Self

Converts to this type from the input type.

impl TryFrom<&FileConfig> for BodyRead

type Error = GraphFailure

The type returned in the event of a conversion error.

fn try_from(file_config: &FileConfig) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<FileConfig> for BodyRead

type Error = GraphFailure

The type returned in the event of a conversion error.

fn try_from(file_config: FileConfig) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<FileConfig> for BytesMut

type Error = GraphFailure

The type returned in the event of a conversion error.

fn try_from(file_config: FileConfig) -> Result<Self, Self::Error>

Performs the conversion.