Struct sourmash::signature::Signature

pub struct Signature { /* private fields */ }

Implementations

impl Signature

pub fn from_params(params: &ComputeParameters) -> Signature

impl Signature

pub fn builder() -> SignatureBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building Signature. On the builder, call .class(...)(optional), .email(...)(optional), .hash_function(...), .filename(...)(optional), .name(...), .license(...)(optional), .signatures(...), .version(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Signature.

impl Signature

pub fn name(&self) -> String

pub fn set_name(&mut self, name: &str)

pub fn filename(&self) -> String

pub fn set_filename(&mut self, name: &str)

pub fn size(&self) -> usize

pub fn sketches(&self) -> Vec<Sketch>

pub fn reset_sketches(&mut self)

pub fn push(&mut self, sketch: Sketch)

pub fn license(&self) -> String

pub fn class(&self) -> String

pub fn hash_function(&self) -> String

pub fn email(&self) -> String

pub fn md5sum(&self) -> String

pub fn select_sketch(&self, sketch: &Sketch) -> Option<&Sketch>

pub fn get_sketch(&self) -> Option<&Sketch>

pub fn minhash(&self) -> Option<&KmerMinHash>

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Vec<Signature>, Error>

pub fn from_reader<R>(rdr: R) -> Result<Vec<Signature>, Error>

where R: Read,

pub fn load_signatures<R>( buf: R, ksize: Option<usize>, moltype: Option<HashFunctions>, _scaled: Option<u64>, ) -> Result<Vec<Signature>, Error>

where R: Read,

pub fn add_sequence(&mut self, seq: &[u8], force: bool) -> Result<(), Error>

pub fn add_protein(&mut self, seq: &[u8]) -> Result<(), Error>

pub fn iter_mut(&mut self) -> IterMut<'_>

pub fn iter(&self) -> Iter<'_>

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Comparable<Signature> for Signature

fn similarity(&self, other: &Signature) -> f64

fn containment(&self, other: &Signature) -> f64

impl Debug for Signature

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Signature

fn default() -> Signature

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Signature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SigStore> for Signature

fn from(other: SigStore) -> Signature

Converts to this type from the input type.

impl From<Signature> for SigStore

fn from(other: Signature) -> SigStore

Converts to this type from the input type.

impl<'a> IntoIterator for &'a mut Signature

type Item = &'a mut Sketch

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a>

Creates an iterator from a value.

impl PartialEq for Signature

fn eq(&self, other: &Signature) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReadData<Signature> for SigStore

fn data(&self) -> Result<&Signature>

impl Select for Signature

fn select(self, selection: &Selection) -> Result<Self, Error>

impl Serialize for Signature

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToWriter for Signature

fn to_writer<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,