Struct VisitObservation

pub struct VisitObservation {
    pub url: Url,
    pub title: Option<String>,
    pub visit_type: Option<VisitType>,
    pub is_error: Option<bool>,
    pub is_redirect_source: Option<bool>,
    pub is_permanent_redirect_source: Option<bool>,
    pub at: Option<Timestamp>,
    pub referrer: Option<Url>,
    pub is_remote: Option<bool>,
    pub preview_image_url: Option<Url>,
}

An “observation” based model for updating history. You create a VisitObservation, call functions on it which correspond with what you observed. The page will then be updated using this info.

It’s implemented such that the making of an “observation” is itself significant - it records what specific changes should be made to storage. For example, instead of simple bools with defaults (where you can’t differentiate explicitly setting a value from the default value), we use Option, with the idea being it’s better for a store shaped like Mentat.

It exposes a “builder api”, but for convenience, that API allows Options too. So, eg, .with_title(None) or with_is_error(None) is allowed but records no observation.

Fields

url: Url

title: Option<String>

visit_type: Option<VisitType>

is_error: Option<bool>

is_redirect_source: Option<bool>

is_permanent_redirect_source: Option<bool>

at: Option<Timestamp>

referrer: Option<Url>

is_remote: Option<bool>

preview_image_url: Option<Url>

Implementations

impl VisitObservation

pub fn new(url: Url) -> Self

pub fn with_title(self, t: impl Into<Option<String>>) -> Self

pub fn with_visit_type(self, t: impl Into<Option<VisitType>>) -> Self

pub fn with_is_error(self, v: impl Into<Option<bool>>) -> Self

pub fn with_is_redirect_source(self, v: impl Into<Option<bool>>) -> Self

pub fn with_is_permanent_redirect_source( self, v: impl Into<Option<bool>>, ) -> Self

pub fn with_at(self, v: impl Into<Option<Timestamp>>) -> Self

pub fn with_is_remote(self, v: impl Into<Option<bool>>) -> Self

pub fn with_referrer(self, v: impl Into<Option<Url>>) -> Self

pub fn with_preview_image_url(self, v: impl Into<Option<Url>>) -> Self

pub fn get_redirect_frecency_boost(&self) -> bool

pub fn get_is_hidden(&self) -> bool

Trait Implementations

impl Clone for VisitObservation

fn clone(&self) -> VisitObservation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for VisitObservation

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for VisitObservation

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for VisitObservation

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for VisitObservation

type FfiType = <VisitObservation as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for VisitObservation

type LiftType = VisitObservation

impl<UT> LiftReturn<UT> for VisitObservation

type ReturnType = <VisitObservation as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for VisitObservation

type FfiType = <VisitObservation as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for VisitObservation

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for VisitObservation

type ReturnType = <VisitObservation as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for VisitObservation

const TYPE_ID_META: MetadataBuffer = _