Skip to main content

IndexNowApi

Struct IndexNowApi 

Source
pub struct IndexNowApi { /* private fields */ }
Expand description

IndexNow client bound to one website (host) and one IndexNow key.

Create it with IndexNowApi::new, optionally change the endpoint with set_search_engine or the key file location with set_key_location, then call send_urls.

Implementations§

Source§

impl IndexNowApi

Source

pub fn new<T: ToString, U: ToString>(host: T, key: U) -> IndexNowApi

Creates a client for host authenticated with key.

  • host – hostname of the site whose URLs you will submit, e.g. www.example.com.
  • key – your IndexNow key: 8 to 128 characters of a-z, A-Z, 0-9 and -. The same key must be served as plain text at https://<host>/<key>.txt (or at the URL given to set_key_location).

The endpoint defaults to https://api.indexnow.org.

Source

pub fn set_search_engine<T: ToString>(&mut self, search_engine: T)

Sets the search engine origin to submit to. Pass the origin without the /IndexNow path, for example https://www.bing.com or https://yandex.com.

Default: https://api.indexnow.org (shared endpoint that notifies every participating engine).

Source

pub fn set_key_location<T: ToString>(&mut self, key_location: T)

Sets the keyLocation field: the full URL of your key file when it is not at the default https://<host>/<key>.txt.

Source

pub async fn send_urls<T: ToString>( &self, urls: Vec<T>, ) -> Result<(), IndexNowError>

Submits urls to the search engine as one POST /IndexNow request.

All URLs must belong to host. IndexNow accepts up to 10,000 URLs per request. Returns Ok(()) when the endpoint answers with HTTP 200 or 202 (accepted, key validation pending), IndexNowError::Status for any other status and IndexNowError::Connection when the request could not be sent.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more