Struct places::observation::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 Debug for VisitObservation

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

Formats the value using the given formatter.