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.

Cloning a session is cheap and shares the backing store: a variable registered through one clone (via VortexSession::with_some or one of the with_* helpers) is observed by all clones. To build an independent session, start from VortexSession::empty.

Implementations

impl VortexSession

pub fn empty() -> Self

Create a new VortexSession with no session state.

pub fn register<V: VortexSessionVar>(&self, var: V)

Inserts a session variable of type V, replacing any existing variable of that type.

This is the copy-on-write insert primitive behind with_some and get_mut; it is not public, so a variable can only enter the type-map through those (or through a default inserted by get). The mutation is applied in place to the shared backing store, so it is visible through every clone.

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

Inserts a new session variable of type V with its default value, mutating this session in place and returning it for chaining.

The change is applied copy-on-write to the shared backing store, so it is observed through every clone of this session.

Panics

If a variable of that type already exists.

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

Inserts a new session variable of type V, mutating this session in place and returning it for chaining.

The change is applied copy-on-write to the shared backing store, so it is observed through every clone of this session.

Panics

If a variable of that type already exists.

pub fn allows_unknown(&self) -> bool

Returns whether unknown plugins should deserialize as foreign placeholders.

pub fn allow_unknown(&self)

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

Mutates this session in place and returns it for chaining.

Trait Implementations

impl Clone for VortexSession

fn clone(&self) -> Self

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 session(&self) -> VortexSession

Returns the VortexSession.

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

Returns the session variable of type V, inserting a default one if it does not exist.

fn get_opt<V: VortexSessionVar>(&self) -> Option<SessionGuard<'_, V>>

Returns the session variable of type V if it exists.

fn get_mut<V: VortexSessionVar + Default + Clone>(&self) -> SessionMut<'_, V>

Returns a copy-on-write SessionMut handle for the variable of type V, inserting a default one first if it does not exist.