pub struct EncoderOption {
pub bases: Vec<u8>,
}Expand description
Options for configuring the FASTA sequence encoder.
This struct provides configuration options for encoding FASTA sequences, such as which bases to consider during encoding.
§Fields
bases- A vector of valid bases (as bytes) to use for encoding. Defaults to “ATCGN”.
§Example
use deepbiop_fa::encode::option::EncoderOption;
let options = EncoderOption::default();Fields§
§bases: Vec<u8>Trait Implementations§
Source§impl Clone for EncoderOption
impl Clone for EncoderOption
Source§fn clone(&self) -> EncoderOption
fn clone(&self) -> EncoderOption
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for EncoderOption
impl Debug for EncoderOption
Source§impl Default for EncoderOption
impl Default for EncoderOption
Source§fn default() -> EncoderOption
fn default() -> EncoderOption
Returns the “default value” for a type. Read more
Source§impl<'de> Deserialize<'de> for EncoderOption
impl<'de> Deserialize<'de> for EncoderOption
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl Display for EncoderOption
impl Display for EncoderOption
Source§impl<'py> IntoPyObject<'py> for EncoderOption
impl<'py> IntoPyObject<'py> for EncoderOption
Source§type Target = EncoderOption
type Target = EncoderOption
The Python output type
Source§type Output = Bound<'py, <EncoderOption as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <EncoderOption as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for EncoderOption
impl PyClass for EncoderOption
Source§impl PyClassImpl for EncoderOption
impl PyClassImpl for EncoderOption
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// Options for configuring the FASTA sequence encoder.
///
/// This struct provides configuration options for encoding FASTA sequences,
/// such as which bases to consider during encoding.
///
/// # Fields
///
/// * `bases` - A vector of valid bases (as bytes) to use for encoding. Defaults to "ATCGN".
///
/// # Example
///
/// ```
/// use deepbiop_fa::encode::option::EncoderOption;
///
/// let options = EncoderOption::default();
/// ```
const RAW_DOC: &'static CStr = /// Options for configuring the FASTA sequence encoder. /// /// This struct provides configuration options for encoding FASTA sequences, /// such as which bases to consider during encoding. /// /// # Fields /// /// * `bases` - A vector of valid bases (as bytes) to use for encoding. Defaults to "ATCGN". /// /// # Example /// /// ``` /// use deepbiop_fa::encode::option::EncoderOption; /// /// let options = EncoderOption::default(); /// ```
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<EncoderOption>
type ThreadChecker = SendablePyClass<EncoderOption>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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<isize>
fn weaklist_offset() -> Option<isize>
Source§impl PyClassNewTextSignature for EncoderOption
impl PyClassNewTextSignature for EncoderOption
const TEXT_SIGNATURE: &'static str = "(bases)"
Source§impl PyMethods<EncoderOption> for PyClassImplCollector<EncoderOption>
impl PyMethods<EncoderOption> for PyClassImplCollector<EncoderOption>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyStubType for EncoderOption
impl PyStubType for EncoderOption
Source§fn type_output() -> TypeInfo
fn type_output() -> TypeInfo
The type to be used in the output signature, i.e. return type of the Python function or methods.
Source§fn type_input() -> TypeInfo
fn type_input() -> TypeInfo
The type to be used in the input signature, i.e. the arguments of the Python function or methods. Read more
Source§impl PyTypeInfo for EncoderOption
impl PyTypeInfo for EncoderOption
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
Source§impl Serialize for EncoderOption
impl Serialize for EncoderOption
impl DerefToPyAny for EncoderOption
impl ExtractPyClassWithClone for EncoderOption
Auto Trait Implementations§
impl Freeze for EncoderOption
impl RefUnwindSafe for EncoderOption
impl Send for EncoderOption
impl Sync for EncoderOption
impl Unpin for EncoderOption
impl UnwindSafe for EncoderOption
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<'a, 'py, T> FromPyObject<'a, 'py> for T
impl<'a, 'py, T> FromPyObject<'a, 'py> for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.