pub struct ColumnReader<'a> { /* private fields */ }Expand description
A handle to one column of a BinTable, from BinTable::column_by_idx or
BinTable::column_by_name. Decode through it without re-passing the column
descriptor: raw for the typed values, physical
for the scaled f64 plane, unsigned/complex/
bits for the special kinds, and vla (+
vla_physical/vla_bits) for
variable-length P/Q columns. Borrows the table, so it cannot outlive it.
Implementations§
Source§impl<'a> ColumnReader<'a>
impl<'a> ColumnReader<'a>
Sourcepub fn descriptor(&self) -> &'a Column
pub fn descriptor(&self) -> &'a Column
The column’s Column descriptor — name, TFORMn, TSCALn/TZEROn/TNULLn,
TDIMn, TDISPn.
Sourcepub fn raw(&self) -> Result<ColumnData>
pub fn raw(&self) -> Result<ColumnData>
Decode a fixed-width column into a typed, row-flattened ColumnData: A is
one String per row, every other fixed kind decodes from the concatenated
cell bytes. Variable-length (P/Q) columns error here — use
ColumnReader::vla.
Sourcepub fn physical(&self) -> Result<Vec<f64>>
pub fn physical(&self) -> Result<Vec<f64>>
The numeric column scaled to its physical f64 plane: TZEROn + TSCALn × raw,
mapping integers equal to TNULLn to NaN. Errors for the non-numeric kinds
(A/L/X/C/M) and variable-length columns.
Sourcepub fn unsigned(&self) -> Result<Option<UnsignedView>>
pub fn unsigned(&self) -> Result<Option<UnsignedView>>
Exact typed integers when the column uses the FITS unsigned (or signed-byte)
convention — TSCALn == 1, no TNULLn, TZEROn the matching sign-bit offset
on a B/I/J/K column — without the f64 rounding of
physical. Ok(None) for any other column; errors only for a
variable-length column. Mirrors crate::Image::unsigned.
Sourcepub fn complex(&self) -> Result<Vec<Complex<f64>>>
pub fn complex(&self) -> Result<Vec<Complex<f64>>>
A C/M complex column as Complex<f64> values, applying TZEROn + TSCALn ×
to each component (§6.4). Errors on non-complex columns.
Sourcepub fn bits(&self) -> Result<BitColumn<'a>>
pub fn bits(&self) -> Result<BitColumn<'a>>
An X (bit-array) column as a borrowed 2-D BitColumn — nrows × repeat
bits viewed in place over the data unit, MSB-first (bit 0 is the MSB of the
first byte, §7.3.2), with no per-row allocation. Errors on any non-X column.
Sourcepub fn vla(&self) -> Result<Vec<ColumnData>>
pub fn vla(&self) -> Result<Vec<ColumnData>>
Decode a variable-length (P/Q) column: one ColumnData per row, each
holding that row’s heap array (which may be empty). Errors for fixed-width
columns.
Sourcepub fn vla_physical(&self) -> Result<Vec<Vec<f64>>>
pub fn vla_physical(&self) -> Result<Vec<Vec<f64>>>
Scale each row of a P/Q column to its physical plane: TZEROn + TSCALn × element, mapping integers equal to TNULLn to NaN (§6.4 — scaling applies to
the heap values). Errors for fixed-width or non-numeric-heap columns.
Sourcepub fn vla_bits(&self) -> Result<BitColumn<'a>>
pub fn vla_bits(&self) -> Result<BitColumn<'a>>
A variable-length X (1PX/1QX) column as a borrowed 2-D BitColumn,
MSB-first (§7.3.2/§7.3.5 — the descriptor’s element count is the bit count). The
rows are jagged (each its own length), so BitColumn::row(r).len() gives a
row’s width. Errors on any non-bit VLA.
Trait Implementations§
Source§impl<'a> Clone for ColumnReader<'a>
impl<'a> Clone for ColumnReader<'a>
Source§fn clone(&self) -> ColumnReader<'a>
fn clone(&self) -> ColumnReader<'a>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<'a> Debug for ColumnReader<'a>
impl<'a> Debug for ColumnReader<'a>
impl<'a> Copy for ColumnReader<'a>
Auto Trait Implementations§
impl<'a> Freeze for ColumnReader<'a>
impl<'a> RefUnwindSafe for ColumnReader<'a>
impl<'a> Send for ColumnReader<'a>
impl<'a> Sync for ColumnReader<'a>
impl<'a> Unpin for ColumnReader<'a>
impl<'a> UnsafeUnpin for ColumnReader<'a>
impl<'a> UnwindSafe for ColumnReader<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.