Enum Writeable 

pub enum Writeable {
    Dyn(Box<dyn DynWriteable>),
    Local(File),
    Cloud(BlockingCloudWriter),
}

Available on crate feature polars-io only.

Holds a non-async writeable file, abstracted over local files or cloud files.

This implements DerefMut to a trait object implementing std::io::Write.

Also see: Writeable::try_into_async_writeable and AsyncWriteable.

Variants

Dyn(Box<dyn DynWriteable>)

An abstract implementation for writable.

This is used to implement writing to in-memory and arbitrary file descriptors.

Local(File)

Cloud(BlockingCloudWriter)

Implementations

impl Writeable

pub fn try_new( path: PlPathRef<'_>, cloud_options: Option<&CloudOptions>, ) -> Result<Writeable, PolarsError>

pub fn try_into_async_writeable(self) -> Result<AsyncWriteable, PolarsError>

This returns Result<> - if a write was performed before calling this, CloudWriter can be in an Err(_) state.

pub fn sync_on_close( &mut self, sync_on_close: SyncOnCloseType, ) -> Result<(), Error>

pub fn close(self) -> Result<(), Error>

Trait Implementations

impl Deref for Writeable

type Target = dyn Write + Send

The resulting type after dereferencing.

fn deref(&self) -> &<Writeable as Deref>::Target

Dereferences the value.

impl DerefMut for Writeable

fn deref_mut(&mut self) -> &mut <Writeable as Deref>::Target

Mutably dereferences the value.