Struct observation_tools_client::artifacts::Image2Builder

pub struct Image2Builder { /* private fields */ }

An image.

Example

use observation_tools_client::artifacts::Image2Builder;
use observation_tools_client::artifacts::Object2Builder;
use observation_tools_client::artifacts::PerPixelTransformBuilder;
use observation_tools_client::artifacts::Point2Builder;
use observation_tools_client::artifacts::Rect2Builder;
use observation_tools_client::artifacts::Segment2Builder;
use observation_tools_client::artifacts::Transform2Builder;

#[tokio::main]
async fn main() -> Result<(), observation_tools_client::ClientError> {
    tracing_subscriber::fmt::init();
    let client = observation_tools_client::test_utils::create_doc_test_client()?;

    // Set up a 2D group:
    let run = client.create_run("create_image2")?;
    let group2d = run.child_uploader_2d("image2_world")?;

    // Basic usage:
    group2d.create_object2(
        "my_image",
        Image2Builder::new(include_bytes!("../testdata/logo_dark.png"), "image/png"),
    )?;

    // Single-channel images:
    let width = 64;
    let height = 64;
    let mut image = vec![0u8; width * height];
    for y in 0..height {
        for x in 0..width {
            // Make a diagonal pattern
            image[(y * width + x)] = ((x + y) / 8) as u8;
        }
    }
    let mut single_channel_image =
        Image2Builder::from_grayscale_pixels(&image, width as u32, height as u32)?;
    // Optionally set a per-pixel transform to colorize the image:
    single_channel_image
        .set_per_pixel_transform(PerPixelTransformBuilder::random_distinct_color());
    group2d.create_object2("single_channel_image", single_channel_image)?;

    client.shutdown().await?;
    Ok(())
}

Implementations

impl Image2Builder

pub fn new(data: &[u8], mime_type: &str) -> Self

pub fn from_grayscale_pixels( data: &[u8], width: u32, height: u32 ) -> Result<Image2Builder, ClientError>

pub fn set_per_pixel_transform(&mut self, transform: PerPixelTransformBuilder)

Trait Implementations

impl Clone for Image2Builder

fn clone(&self) -> Image2Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Image2Builder> for JsValue

fn from(value: Image2Builder) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Image2Builder

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl Into<Geometry2Builder> for Image2Builder

fn into(self) -> Geometry2Builder

Converts this type into the (usually inferred) input type.

impl Into<Object2Builder> for Image2Builder

fn into(self) -> Object2Builder

Converts this type into the (usually inferred) input type.

impl IntoWasmAbi for Image2Builder

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Image2Builder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, Image2Builder>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Image2Builder

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Image2Builder

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Image2Builder

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Image2Builder>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Image2Builder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Image2Builder>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for Image2Builder

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for Image2Builder

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Image2Builder]>

impl VectorIntoWasmAbi for Image2Builder

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Image2Builder]>) -> Self::Abi

impl WasmDescribe for Image2Builder

fn describe()

impl WasmDescribeVector for Image2Builder

fn describe_vector()