Struct Brouter

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

A client for the BRouter server

Implementations§

Source§

impl Brouter

Source

pub fn new(base_url: &str) -> Self

Create a new BRouter client with the given base URL

Source

pub fn local() -> Result<Self, Box<dyn Error>>

Run the BRouter server locally and connect to it

Source

pub fn upload_profile(&self, profile: &str, data: Vec<u8>) -> Result<(), Error>

Upload a profile to the BRouter server

Source

pub fn broute( &self, points: &[Point], nogos: &[Nogo], profile: &str, alternativeidx: Option<u8>, timode: Option<TurnInstructionMode>, name: Option<&str>, export_waypoints: bool, ) -> Result<Gpx, Error>

Route between the given points

§Arguments
  • points - A list of points to route between
  • nogos - A list of nogos to avoid
  • profile - The profile to use for routing
  • alternativeidx - The index of the alternative route to use
  • timode - The mode for turn instructions
  • name - The name of the route
  • export_waypoints - Whether to export waypoints

Trait Implementations§

Source§

impl Drop for Brouter

Source§

fn drop(&mut self)

Executes the destructor for this type. 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> 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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,