Struct Definition

pub struct Definition { /* private fields */ }

A FASTA record definition.

A definition represents a definition line, i.e, a reference sequence name and, optionally, a description.

Implementations

impl Definition

pub fn new<N>(name: N, description: Option<Vec<u8>>) -> Self

where N: Into<Vec<u8>>,

Creates a FASTA record definition.

Examples

use noodles_fasta::record::Definition;
let definition = Definition::new("sq0", None);

pub fn name(&self) -> &[u8]

Returns the record name.

Examples

use noodles_fasta::record::Definition;
let definition = Definition::new("sq0", None);
assert_eq!(definition.name(), b"sq0");

pub fn description(&self) -> Option<&[u8]>

Returns the description if it is set.

Examples

use noodles_fasta::record::Definition;

let definition = Definition::new("sq0", None);
assert_eq!(definition.description(), None);

let definition = Definition::new("sq0", Some(Vec::from("LN:13")));
assert_eq!(definition.description(), Some(&b"LN:13"[..]));

Trait Implementations

impl Clone for Definition

fn clone(&self) -> Definition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Definition

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

Formats the value using the given formatter.

impl Display for Definition

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

Formats the value using the given formatter.

impl FromStr for Definition

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Definition

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Definition

impl StructuralPartialEq for Definition