Struct PyStreamingFeatherWriter 

pub struct PyStreamingFeatherWriter { /* private fields */ }

Python binding for the Rust FeatherWriter.

This provides a streaming writer of Nautilus objects into feather files with rotation capabilities, matching the interface of Python’s StreamingFeatherWriter.

Implementations

impl PyStreamingFeatherWriter

pub fn new( path: String, cache: PyCache, clock: PyClock, fs_protocol: Option<&str>, fs_storage_options: Option<HashMap<String, String>>, include_types: Option<Vec<String>>, rotation_mode: u8, max_file_size: u64, rotation_interval_ns: Option<u64>, rotation_time_ns: Option<u64>, rotation_timezone: &str, flush_interval_ms: Option<u64>, replace: bool, ) -> PyResult<Self>

Creates a new StreamingFeatherWriter instance.

Parameters

• path: The path to persist the stream to. Must be a directory.
• cache: The cache for query info (PyCache).
• clock: The clock to use for time-related operations (PyClock).
• fs_protocol: Optional filesystem protocol (default: “file”).
• fs_storage_options: Optional storage options for cloud backends.
• include_types: Optional list of type names to include (e.g., [“quotes”, “trades”]).
• rotation_mode: Rotation mode (0=SIZE, 1=INTERVAL, 2=SCHEDULED_DATES, 3=NO_ROTATION).
• max_file_size: Maximum file size in bytes before rotation (for SIZE mode).
• rotation_interval_ns: Rotation interval in nanoseconds (for INTERVAL/SCHEDULED_DATES modes).
• rotation_time_ns: Scheduled rotation time in nanoseconds (for SCHEDULED_DATES mode).
• flush_interval_ms: Flush interval in milliseconds (default: 1000). Set to 0 to disable auto-flush.
• replace: If existing files at the given path should be replaced (default: False).

pub fn subscribe(&mut self) -> PyResult<()>

Subscribes to all messages on the message bus (pattern “*”).

This matches the behavior of Python’s StreamingFeatherWriter when subscribed via trader.subscribe("*", writer.write).

pub fn unsubscribe(&mut self) -> PyResult<()>

Unsubscribes from the message bus.

pub fn write(&self, py: Python<'_>, data: Py<PyAny>) -> PyResult<()>

Writes a data object to the stream.

Parameters

• data: The data object to write (must be a Nautilus data type from pyo3).

pub fn flush(&self) -> PyResult<()>

Flushes all active buffers by writing any remaining buffered bytes to the object store.

This is called automatically based on flush_interval_ms if configured, but can also be called manually by the client.

pub fn close(&self) -> PyResult<()>

Closes all writers by flushing and removing them.

After calling this, no further writes should be performed.

pub fn is_closed(&self) -> bool

Returns whether the writer has been closed (no active writers).

pub fn get_current_file_info(&self) -> HashMap<String, (u64, String)>

Returns information about the current files being written.

Returns a dictionary mapping writer keys to (size, path) tuples.

pub fn get_next_rotation_time( &self, type_str: &str, instrument_id: Option<&str>, ) -> Option<u64>

Returns the next rotation time for a writer, or None if not set.

Trait Implementations

impl<'py> IntoPyObject<'py> for PyStreamingFeatherWriter

type Target = PyStreamingFeatherWriter

The Python output type

type Output = Bound<'py, <PyStreamingFeatherWriter as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyStreamingFeatherWriter

const NAME: &str = "StreamingFeatherWriter"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyStreamingFeatherWriter

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Python binding for the Rust `FeatherWriter`. /// /// This provides a streaming writer of Nautilus objects into feather files with rotation /// capabilities, matching the interface of Python's `StreamingFeatherWriter`.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<PyStreamingFeatherWriter as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyStreamingFeatherWriter>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerImpl

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPyStreamingFeatherWriter

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyStreamingFeatherWriter

const TEXT_SIGNATURE: &'static str = "(path, cache, clock, fs_protocol=None, fs_storage_options=None, include_types=None, rotation_mode=3, max_file_size=..., rotation_interval_ns=None, rotation_time_ns=None, rotation_timezone=\"UTC\", flush_interval_ms=None, replace=False)"

impl PyStubType for PyStreamingFeatherWriter

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for PyStreamingFeatherWriter

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for PyStreamingFeatherWriter

impl ExtractPyClassWithClone for PyStreamingFeatherWriter