Skip to main content

NDPluginFileBase

Struct NDPluginFileBase 

Source
pub struct NDPluginFileBase {
    pub file_path: String,
    pub file_name: String,
    pub file_number: i32,
    pub file_template: String,
    pub auto_increment: bool,
    pub temp_suffix: String,
    pub create_dir: i32,
    /* private fields */
}
Expand description

File path/name management and capture buffering for file plugins.

Fields§

§file_path: String§file_name: String§file_number: i32§file_template: String§auto_increment: bool§temp_suffix: String§create_dir: i32

Implementations§

Source§

impl NDPluginFileBase

Source

pub fn new() -> Self

Source

pub fn create_file_name(&self) -> String

Construct the full file path from template/path/name/number.

Source

pub fn temp_file_path(&self) -> Option<PathBuf>

Get the temp file path (if temp_suffix is set).

Source

pub fn ensure_directory(&self) -> ADResult<()>

Create directory if needed.

Source

pub fn process_array( &mut self, array: Arc<NDArray>, writer: &mut dyn NDFileWriter, ) -> ADResult<()>

Process an incoming array according to the current file mode.

Source

pub fn flush_capture(&mut self, writer: &mut dyn NDFileWriter) -> ADResult<()>

Flush capture buffer: open file, write all buffered arrays, close.

Source

pub fn close_stream(&mut self, writer: &mut dyn NDFileWriter) -> ADResult<()>

Close stream mode.

Source

pub fn set_mode(&mut self, mode: NDFileMode)

Source

pub fn set_num_capture(&mut self, n: usize)

Source

pub fn num_captured(&self) -> usize

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more