Struct BigBedWrite

Source
pub struct BigBedWrite<W: Write + Seek + Send + 'static> {
    pub options: BBIWriteOptions,
    pub autosql: Option<String>,
    /* private fields */
}
Expand description

The struct used to write a bigBed file

Fields§

§options: BBIWriteOptions§autosql: Option<String>

Implementations§

Source§

impl BigBedWrite<File>

Source

pub fn create_file( path: impl AsRef<Path>, chrom_sizes: HashMap<String, u32>, ) -> Result<Self>

Source§

impl<W: Write + Seek + Send + 'static> BigBedWrite<W>

Source

pub fn new(out: W, chrom_sizes: HashMap<String, u32>) -> Self

Source

pub fn write<V: BBIDataSource<Value = BedEntry>>( self, vals: V, runtime: Runtime, ) -> Result<(), BBIProcessError<V::Error>>

Write the values from V as a bigWig. Will utilize the provided runtime for encoding values and for reading through the values (potentially parallelized by chromosome).

Source

pub fn write_multipass<V: BBIDataSource<Value = BedEntry>>( self, make_vals: impl Fn() -> Result<V, BBIProcessError<V::Error>>, runtime: Runtime, ) -> Result<(), BBIProcessError<V::Error>>

Write the values from V as a bigBed. Will utilize the provided runtime for encoding values and for reading through the values (potentially parallelized by chromosome). This will take two passes on the provided values: first to write the values themselves, then the zooms. This is beneficial over write on smaller files, where the encoding of high resolution zooms takes up a substantial portion of total processing time.

Auto Trait Implementations§

§

impl<W> Freeze for BigBedWrite<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for BigBedWrite<W>
where W: RefUnwindSafe,

§

impl<W> Send for BigBedWrite<W>

§

impl<W> Sync for BigBedWrite<W>
where W: Sync,

§

impl<W> Unpin for BigBedWrite<W>
where W: Unpin,

§

impl<W> UnwindSafe for BigBedWrite<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,