Struct Injector 

pub struct Injector<T, R> { /* private fields */ }

A handle which allows adding new items to a Picker.

This struct is cheaply clonable and can be sent across threads. By default, add new items to the Picker using the push method. For convenience, an injector also implements Extend if you want to add items from an iterator.

DeserializeSeed implementation

If your items are being read from an external source and deserialized within the serde framework, you may find it convenient to enable the serde optional feature. With this feature enabled, an injector implements DeserializeSeed and expects a sequence of picker items. The DeserializeSeed implementation sends the items to the picker immediately, without waiting for the entire file to be deserialized (or even loaded into memory).

use nucleo_picker::{render::StrRenderer, Picker, Render};
use serde::{de::DeserializeSeed, Deserialize};
use serde_json::Deserializer;

let input = r#"
  [
   "Alvar Aalto",
   "Frank Lloyd Wright",
   "Zaha Hadid",
   "Le Corbusier"
  ]
"#;

// the type annotation here also tells `serde_json` to deserialize `input` as a sequence of
// `String`.
let mut picker: Picker<String, _> = Picker::new(StrRenderer);
let injector = picker.injector();

// in practice, you would read from a file or a socket and use
// `Deserializer::from_reader` instead, and run this in a separate thread
injector
    .deserialize(&mut Deserializer::from_str(input))
    .unwrap();

Implementations

impl<T, R: Render<T>> Injector<T, R>

pub fn push(&self, item: T)

Add an item to the picker.

pub fn extend_exact<I>(&self, iter: I)

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: ExactSizeIterator,

Add items from an iterator to the picker, when the number of items in the iterator is known exactly.

This can result in more efficient insertion when inserting a large number of elements in a single batch.

pub fn renderer(&self) -> &R

Returns a reference to the renderer internal to the picker.

Trait Implementations

impl<T, R> Clone for Injector<T, R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de, T, R> DeserializeSeed<'de> for &Injector<T, R>

where T: Send + Sync + 'static + Deserialize<'de>, R: Render<T>,

Available on crate feature serde only.

fn deserialize<D>(self, deserializer: D) -> Result<Self::Value, D::Error>

where D: Deserializer<'de>,

Deserialize from a sequence of picker items. This implementation is enabled using the serde feature.

type Value = ()

The type produced by using this seed.

impl<T, R: Render<T>> Extend<T> for Injector<T, R>

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'de, T, R> Visitor<'de> for &Injector<T, R>

where T: Send + Sync + 'static + Deserialize<'de>, R: Render<T>,

Available on crate feature serde only.

type Value = ()

The value produced by this visitor.

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

Format a message stating what data this Visitor expects to receive.

fn visit_seq<S>(self, seq: S) -> Result<(), S::Error>

where S: SeqAccess<'de>,

The input contains a sequence of elements.

fn visit_bool<E>(self, v: bool) -> Result<Self::Value, E>

where E: Error,

The input contains a boolean.

fn visit_i8<E>(self, v: i8) -> Result<Self::Value, E>

where E: Error,

The input contains an i8.

fn visit_i16<E>(self, v: i16) -> Result<Self::Value, E>

where E: Error,

The input contains an i16.

fn visit_i32<E>(self, v: i32) -> Result<Self::Value, E>

where E: Error,

The input contains an i32.

fn visit_i64<E>(self, v: i64) -> Result<Self::Value, E>

where E: Error,

The input contains an i64.

fn visit_i128<E>(self, v: i128) -> Result<Self::Value, E>

where E: Error,

The input contains a i128.

fn visit_u8<E>(self, v: u8) -> Result<Self::Value, E>

where E: Error,

The input contains a u8.

fn visit_u16<E>(self, v: u16) -> Result<Self::Value, E>

where E: Error,

The input contains a u16.

fn visit_u32<E>(self, v: u32) -> Result<Self::Value, E>

where E: Error,

The input contains a u32.

fn visit_u64<E>(self, v: u64) -> Result<Self::Value, E>

where E: Error,

The input contains a u64.

fn visit_u128<E>(self, v: u128) -> Result<Self::Value, E>

where E: Error,

The input contains a u128.

fn visit_f32<E>(self, v: f32) -> Result<Self::Value, E>

where E: Error,

The input contains an f32.

fn visit_f64<E>(self, v: f64) -> Result<Self::Value, E>

where E: Error,

The input contains an f64.

fn visit_char<E>(self, v: char) -> Result<Self::Value, E>

where E: Error,

The input contains a char.

fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>

where E: Error,

The input contains a string. The lifetime of the string is ephemeral and it may be destroyed after this method returns.

fn visit_borrowed_str<E>(self, v: &'de str) -> Result<Self::Value, E>

where E: Error,

The input contains a string that lives at least as long as the Deserializer.

fn visit_string<E>(self, v: String) -> Result<Self::Value, E>

where E: Error,

Available on crate features std or alloc only.

The input contains a string and ownership of the string is being given to the Visitor.

fn visit_bytes<E>(self, v: &[u8]) -> Result<Self::Value, E>

where E: Error,

The input contains a byte array. The lifetime of the byte array is ephemeral and it may be destroyed after this method returns.

fn visit_borrowed_bytes<E>(self, v: &'de [u8]) -> Result<Self::Value, E>

where E: Error,

The input contains a byte array that lives at least as long as the Deserializer.

fn visit_byte_buf<E>(self, v: Vec<u8>) -> Result<Self::Value, E>

where E: Error,

Available on crate features std or alloc only.

The input contains a byte array and ownership of the byte array is being given to the Visitor.

fn visit_none<E>(self) -> Result<Self::Value, E>

where E: Error,

The input contains an optional that is absent.

fn visit_some<D>( self, deserializer: D, ) -> Result<Self::Value, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

The input contains an optional that is present.

fn visit_unit<E>(self) -> Result<Self::Value, E>

where E: Error,

The input contains a unit ().

fn visit_newtype_struct<D>( self, deserializer: D, ) -> Result<Self::Value, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

The input contains a newtype struct.

fn visit_map<A>( self, map: A, ) -> Result<Self::Value, <A as MapAccess<'de>>::Error>

where A: MapAccess<'de>,

The input contains a key-value map.

fn visit_enum<A>( self, data: A, ) -> Result<Self::Value, <A as EnumAccess<'de>>::Error>

where A: EnumAccess<'de>,

The input contains an enum.