Enum ScanSources

pub enum ScanSources {
    Paths(Arc<[PathBuf]>),
    Files(Arc<[File]>),
    Buffers(Arc<[MemSlice]>),
}

Set of sources to scan from

This can either be a list of paths to files, opened files or in-memory buffers. Mixing of buffers is not currently possible.

Variants

Paths(Arc<[PathBuf]>)

Files(Arc<[File]>)

Buffers(Arc<[MemSlice]>)

Implementations

impl ScanSources

pub fn expand_paths( &self, file_options: &FileScanOptions, cloud_options: Option<&CloudOptions>, ) -> PolarsResult<Self>

pub fn expand_paths_with_hive_update( &self, file_options: &mut FileScanOptions, cloud_options: Option<&CloudOptions>, ) -> PolarsResult<Self>

Available on crate features ipc or parquet only.

This will update file_options.hive_options.enabled to true if the existing value is None and the paths are expanded from a single directory. Otherwise the existing value is maintained.

pub fn iter(&self) -> ScanSourceIter<'_>

pub fn is_paths(&self) -> bool

Are the sources all paths?

pub fn as_paths(&self) -> Option<&[PathBuf]>

Try cast the scan sources to ScanSources::Paths

pub fn into_paths(&self) -> Option<Arc<[PathBuf]>>

Try cast the scan sources to ScanSources::Paths with a clone

pub fn first_path(&self) -> Option<&Path>

Try get the first path in the scan sources

pub fn is_cloud_url(&self) -> bool

Is the first path a cloud URL?

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn first(&self) -> Option<ScanSourceRef<'_>>

pub fn id(&self) -> PlSmallStr

Turn the ScanSources into some kind of identifier

pub fn get(&self, idx: usize) -> Option<ScanSourceRef<'_>>

Get the scan source at specific address

pub fn at(&self, idx: usize) -> ScanSourceRef<'_>

Get the scan source at specific address

Panics

If the idx is out of range.

Trait Implementations

impl Clone for ScanSources

fn clone(&self) -> ScanSources

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScanSources

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

Formats the value using the given formatter.

impl Default for ScanSources

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScanSources

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ScanSources

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScanSources

fn eq(&self, other: &Self) -> 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 ScanSources

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 ScanSources