Skip to main content

ChunkBuilder

Struct ChunkBuilder 

Source
pub struct ChunkBuilder { /* private fields */ }
Expand description

Accumulates atoms and closes chunks at residue boundaries.

Rows are appended in file order. A chunk is closed once it is at or past the target size and the next atom starts a new residue, which is what keeps the no-straddling guarantee without splitting a large residue.

§Examples

use molframe_core::chunk::{AtomRecord, ChunkBuilder};
use molframe_core::{AltId, Element, OptionalSymbol, Presence, ResidueIndex, SymbolId};

let mut builder = ChunkBuilder::new();
builder.push(AtomRecord {
    position: Some([1.0, 2.0, 3.0]),
    element: Element::CARBON,
    atom_name: SymbolId::from_raw(0),
    auth_atom_name: OptionalSymbol::NONE,
    alternate_component_id: OptionalSymbol::NONE,
    alt_id: AltId::BLANK,
    residue: ResidueIndex::new(0),
    occupancy: (1.0, Presence::Present),
    b_factor: (12.5, Presence::Present),
    formal_charge: (0, Presence::Inapplicable),
    atom_site_id: 1,
});

let (chunks, coords) = builder.finish();
assert_eq!(chunks.len(), 1);
assert_eq!(coords.len(), 1);
assert!(chunks[0].stats().elements.contains(Element::CARBON));

Implementations§

Source§

impl ChunkBuilder

Source

pub fn new() -> Self

Creates a builder using the default chunk size.

Source

pub fn with_target(target: u32) -> Self

Creates a builder that closes chunks at target atoms.

Exists for tests and for callers that know their access pattern; the default is what a file read uses.

Source

pub fn reserve(&mut self, atoms: usize)

Reserves room for atoms positions.

Source

pub fn start_model(&mut self, model: u32)

Declares which model the atoms that follow belong to.

Closes the current chunk, because a chunk’s model is constant by construction and that is what lets the column vanish entirely.

Source

pub fn push(&mut self, record: AtomRecord)

Appends an atom.

Source

pub fn finish(self) -> (Vec<AtomChunk>, CoordinateBlock)

Closes the last chunk and returns everything built.

Trait Implementations§

Source§

impl Debug for ChunkBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ChunkBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.