Struct Decoder

pub struct Decoder { /* private fields */ }

A streaming decoder to read a Nucleotide Archive Format file.

Implementations

impl Decoder

pub fn __init__<'py>( file: Bound<'py, PyAny>, id: bool, comment: bool, sequence: bool, quality: bool, mask: bool, buffer_size: Option<usize>, ) -> PyResult<PyClassInitializer<Self>>

pub fn __iter__(slf: PyRef<'_, Self>) -> PyResult<PyRef<'_, Self>>

pub fn __len__(slf: PyRef<'_, Self>) -> PyResult<usize>

pub fn __next__(slf: PyRefMut<'_, Self>) -> PyResult<Option<Record>>

pub fn __enter__<'py>(slf: PyRef<'py, Self>) -> PyRef<'py, Self>

pub fn __exit__<'py>( slf: PyRefMut<'py, Self>, exc_type: Bound<'py, PyAny>, exc_value: Bound<'py, PyAny>, traceback: Bound<'py, PyAny>, ) -> PyResult<bool>

pub fn sequence_type(slf: PyRef<'_, Self>) -> SequenceType

str: The type of sequence stored in the archive.

pub fn format_version(slf: PyRef<'_, Self>) -> &Bound<'_, PyString>

str: The length of sequence lines in the original FASTA file.

pub fn line_length(slf: PyRef<'_, Self>) -> u64

int: The length of sequence lines in the original FASTA file.

pub fn name_separator(slf: PyRef<'_, Self>) -> char

str: The separator between sequence identifiers and comments.

pub fn number_of_sequences(slf: PyRef<'_, Self>) -> u64

int: The total number of sequences stored in the archive.

pub fn read(slf: PyRefMut<'_, Self>) -> PyResult<Option<Record>>

Read the next record from the archive.

This method will returns None when no more records are available.

Trait Implementations

impl IntoPy<Py<PyAny>> for Decoder

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for Decoder

type Target = Decoder

The Python output type

type Output = Bound<'py, <Decoder 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 Decoder

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Decoder

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Decoder>

This handles following two situations:

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Decoder> for PyClassImplCollector<Decoder>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Decoder

type Holder = Option<PyRef<'py, Decoder>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Decoder

type Holder = Option<PyRefMut<'py, Decoder>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Decoder> for PyClassImplCollector<Decoder>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Decoder

const NAME: &'static str = "Decoder"

Class name.

const MODULE: Option<&'static str>

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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for Decoder