Skip to main content

PackageIndex

Struct PackageIndex 

Source
pub struct PackageIndex {
Show 17 fields pub format: u32, pub eco: Eco, pub name: String, pub version: String, pub source: String, pub fetched: bool, pub entries: Vec<Entry>, pub npm_api: Option<PublicApi>, pub terms: Vec<Vec<(String, u16)>>, pub lens: Vec<u32>, pub head: Vec<Vec<(String, u16)>>, pub head_lens: Vec<u32>, pub build_ms: u64, pub upstream: Option<String>, pub upstream_provenance: Option<Manifest>, pub embed: String, pub vecs: Vec<Vec8>,
}

Fields§

§format: u32§eco: Eco§name: String§version: String

The version whose files were indexed.

§source: String§fetched: bool§entries: Vec<Entry>§npm_api: Option<PublicApi>§terms: Vec<Vec<(String, u16)>>§lens: Vec<u32>§head: Vec<Vec<(String, u16)>>

Terms of the heading or name plus the first sentence only, ranked on their own so a long body does not bury what the entry says it is.

§head_lens: Vec<u32>§build_ms: u64§upstream: Option<String>

github.com/o/r@tag (N files) when upstream docs are included.

§upstream_provenance: Option<Manifest>

Fetch manifest used by this index, including immutable commit and failure notes.

§embed: String

Embedding model id, or empty for keyword-only.

§vecs: Vec<Vec8>

One embedding per entry (empty without a model).

Implementations§

Source§

impl PackageIndex

Source

pub fn api_entries(&self) -> &[Entry]

Source

pub fn docs_indices(&self, import: Option<&str>) -> Vec<usize>

Source

pub fn id(&self) -> String

Trait Implementations§

Source§

impl<'de> Deserialize<'de> for PackageIndex

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 Serialize for PackageIndex

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.