Skip to main content

PreviewOutput

Struct PreviewOutput 

Source
pub struct PreviewOutput {
Show 24 fields pub path: String, pub format: String, pub kind: String, pub output: Option<String>, pub encoding: String, pub width: u32, pub height: u32, pub bytes: u64, pub xxh3: String, pub verified: bool, pub image: Option<ImagePreview>, pub trace: Option<TracePreview>, pub spectrum: Option<SpectrumPreview>, pub chromatogram: Option<ChromatogramPreview>, pub plate: Option<PlatePreview>, pub events: Option<EventsPreview>, pub panels: Vec<PlotPanel>, pub marks: Vec<DataMark>, pub objects: Option<Objects>, pub lanes: Option<Lanes>, pub annotations: Vec<DrawnAnnotation>, pub notes: Vec<String>, pub hint: Option<String>, pub save: Option<String>,
}
Expand description

Output of preview: what was rendered, and where it went.

Fields§

§path: String

The input file.

§format: String

Format id of the input file.

§kind: String

image, trace, chromatogram, spectrum, plate or events.

§output: Option<String>

The written file (CLI); absent when the preview is returned inline (MCP image content).

§encoding: String

png, jpeg or svg.

§width: u32

Image width in pixels.

§height: u32

Image height in pixels.

§bytes: u64

Size of the encoded image.

§xxh3: String

xxh3-128 of the encoded bytes, 32 hex chars (identical across runs for the same request).

§verified: bool

True once a written file was read back and matched.

§image: Option<ImagePreview>

Present for image previews.

§trace: Option<TracePreview>

Present for trace previews.

§spectrum: Option<SpectrumPreview>

Present for spectrum previews.

§chromatogram: Option<ChromatogramPreview>

Present for chromatogram previews (a mass-spectrometry run’s total-ion chromatogram).

§plate: Option<PlatePreview>

Present for plate previews.

§events: Option<EventsPreview>

Present for event previews.

§panels: Vec<PlotPanel>

Plot panels (traces, spectra, plate curves, events): where each sits in the picture and the data range it shows.

§marks: Vec<DataMark>

Marks drawn from the data (labelled peaks, action potentials).

§objects: Option<Objects>

marks: objects: the objects counted in the area shown, as stats objects (the first 20 listed).

§lanes: Option<Lanes>

marks: lanes: the lanes and bands found in the area shown, as stats lanes.

§annotations: Vec<DrawnAnnotation>

The caller’s annotations as drawn: each as given, plus where it landed in PNG pixels.

§notes: Vec<String>

Anything the caller should know (fallbacks, caps, implied options).

§hint: Option<String>

What to do next with the picture (look at it; zoom with a region read off the rulers).

§save: Option<String>

How to save this picture to a file (MCP: the openreadout_export call).

Trait Implementations§

Source§

impl Clone for PreviewOutput

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PreviewOutput

Source§

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

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

impl Default for PreviewOutput

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for PreviewOutput

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for PreviewOutput

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for PreviewOutput

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

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

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.