Struct VortexSession 

pub struct VortexSession(/* private fields */);

A Vortex session encapsulates the set of extensible arrays, layouts, compute functions, dtypes, etc. that are available for use in a given context.

It is also the entry-point passed to dynamic libraries to initialize Vortex plugins.

Implementations

impl VortexSession

pub fn empty() -> Self

Create a new VortexSession with no session state.

It is recommended to use the default() method instead provided by the main vortex crate.

pub fn with<V: SessionVar + Default>(self) -> Self

Inserts a new session variable of type V with its default value.

Panics

If a variable of that type already exists.

pub fn with_some<V: SessionVar>(self, var: V) -> Self

Inserts a new session variable of type V.

Panics

If a variable of that type already exists.

pub fn allow_unknown(self) -> Self

Allow deserializing unknown plugin IDs as non-executable foreign placeholders.

pub fn allows_unknown(&self) -> bool

Returns whether unknown plugins should deserialize as foreign placeholders.

Trait Implementations

impl Clone for VortexSession

fn clone(&self) -> VortexSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VortexSession

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

Formats the value using the given formatter.

impl SessionExt for VortexSession

fn get<V: SessionVar + Default>(&self) -> Ref<'_, V>

Returns the scope variable of type V, or inserts a default one if it does not exist.

fn get_mut<V: SessionVar + Default>(&self) -> RefMut<'_, V>

Returns the scope variable of type V, or inserts a default one if it does not exist.

Note that the returned value internally holds a lock on the variable.

fn session(&self) -> VortexSession

Returns the VortexSession.

fn get_opt<V: SessionVar>(&self) -> Option<Ref<'_, V>>

Returns the scope variable of type V if it exists.

fn get_mut_opt<V: SessionVar>(&self) -> Option<RefMut<'_, V>>

Returns the scope variable of type V, if it exists.