Struct noodles_sam::record::Flags [−][src]
pub struct Flags { /* fields omitted */ }
Expand description
SAM record flags.
Implementations
👎 Deprecated since 0.9.0: Use Flags::SEGMENTED
instead.
Use Flags::SEGMENTED
instead.
Read is paired (0x01
).
👎 Deprecated since 0.9.0: Use Flags::PROPERLY_ALIGNED
instead.
Use Flags::PROPERLY_ALIGNED
instead.
Both reads are properly aligned (0x02
).
Each segment in the read is properly aligned (0x02
).
The mate is unmapped (0x08
).
The sequence is reverse complemented (0x10
).
The sequence of the mate is reverse complemented (0x20
).
👎 Deprecated since 0.9.0: Use Flags::FIRST_SEGMENT
instead.
Use Flags::FIRST_SEGMENT
instead.
First in pair (0x40
).
First segment in the read (0x40
).
👎 Deprecated since 0.9.0: Use Flags::LAST_SEGMENT
instead.
Use Flags::LAST_SEGMENT
instead.
Second in pair (0x80
).
Last segment in the read (0x80
).
Supplementary alignment (0x0800
).
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
Returns true
if there are flags common to both self
and other
.
Returns true
if all of the flags in other
are contained within self
.
Inserts or removes the specified flags depending on the passed value.
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
👎 Deprecated since 0.9.0: Use Flags::is_segmented
instead.
Use Flags::is_segmented
instead.
Returns whether the PAIRED
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::PAIRED.is_paired());
assert!(!Flags::UNMAPPED.is_paired());
Returns whether the SEGMENTED
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::SEGMENTED.is_segmented());
assert!(!Flags::UNMAPPED.is_segmented());
👎 Deprecated since 0.9.0: Use Flags::is_properly_aligned
instead.
Use Flags::is_properly_aligned
instead.
Returns whether the PROPER_PAIR
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::PROPER_PAIR.is_proper_pair());
assert!(!Flags::UNMAPPED.is_proper_pair());
Returns whether the PROPERLY_ALIGNED
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::PROPERLY_ALIGNED.is_properly_aligned());
assert!(!Flags::UNMAPPED.is_properly_aligned());
Returns whether the UNMAPPED
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::UNMAPPED.is_unmapped());
assert!(!Flags::PAIRED.is_unmapped());
Returns whether the MATE_UNMAPPED
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::MATE_UNMAPPED.is_mate_unmapped());
assert!(!Flags::UNMAPPED.is_mate_unmapped());
Returns whether the REVERSE_COMPLEMENTED
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::REVERSE_COMPLEMENTED.is_reverse_complemented());
assert!(!Flags::UNMAPPED.is_reverse_complemented());
Returns whether the MATE_REVERSE_COMPLEMENTED
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::MATE_REVERSE_COMPLEMENTED.is_mate_reverse_complemented());
assert!(!Flags::UNMAPPED.is_mate_reverse_complemented());
👎 Deprecated since 0.9.0: Use Flags::is_first_segment
instead.
Use Flags::is_first_segment
instead.
Returns whether the READ_1
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::READ_1.is_read_1());
assert!(!Flags::UNMAPPED.is_read_1());
Returns whether the FIRST_SEGMENT
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::FIRST_SEGMENT.is_first_segment());
assert!(!Flags::UNMAPPED.is_first_segment());
👎 Deprecated since 0.9.0: Use Flags::is_last_segment
instead.
Use Flags::is_last_segment
instead.
Returns whether the READ_2
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::READ_2.is_read_2());
assert!(!Flags::UNMAPPED.is_read_2());
Returns whether the READ_2
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::READ_2.is_read_2());
assert!(!Flags::UNMAPPED.is_read_2());
Returns whether the SECONDARY
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::SECONDARY.is_secondary());
assert!(!Flags::UNMAPPED.is_secondary());
Returns whether the QC_FAIL
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::QC_FAIL.is_qc_fail());
assert!(!Flags::UNMAPPED.is_qc_fail());
Returns whether the DUPLICATE
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::DUPLICATE.is_duplicate());
assert!(!Flags::UNMAPPED.is_duplicate());
Returns whether the SUPPLEMENTARY
flag is set.
Examples
use noodles_sam::record::Flags;
assert!(Flags::SUPPLEMENTARY.is_supplementary());
assert!(!Flags::UNMAPPED.is_supplementary());
Trait Implementations
Disables all flags disabled in the set.
Adds the set of flags.
Toggles the set of flags.
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
Creates a value from an iterator. Read more
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Disables all flags enabled in the set.
Auto Trait Implementations
impl RefUnwindSafe for Flags
impl UnwindSafe for Flags
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.