Skip to main content

AddressesResource

Struct AddressesResource 

Source
pub struct AddressesResource<'a> { /* private fields */ }
Expand description

client.addresses()

Implementations§

Source§

impl<'a> AddressesResource<'a>

Source

pub fn create( &self, domain_type: impl Display, domain_identifier: impl Display, body: &GroupAddressCreate, ) -> Result<StoredAddress>

Create an address for a domain object

POST /addresses/{domainType}/{domainIdentifier}

Creates another stored meeting-place address for the group. Only domainType=group is registered. Requires permission to edit the group’s meeting-place field (treffpunkt). Ownership and address ID are supplied in the path. Coordinates are accepted as numbers or decimal strings and returned as strings or null. The request does not geocode a postal address automatically.

§Example
let body = models::GroupAddressCreate {
    name: Some(Some("Retreat Center".into())),
    ..Default::default()
};
let result = client.addresses().create("group", "42", &body)?;
println!("{:?}", result.name);
Source

pub fn delete( &self, domain_type: impl Display, domain_identifier: impl Display, address_id: impl Display, ) -> Result<()>

Delete an address

DELETE /addresses/{domainType}/{domainIdentifier}/{addressId}

Deletes the stored address identified by addressId. Only domainType=group is registered. Requires permission to edit the meeting-place field (treffpunkt) of the group in the path. The group itself remains. This operation has no dry-run mode; an unknown address ID returns 404.

§Example
client.addresses().delete("group", "42", 7)?;
Source

pub fn get( &self, domain_type: impl Display, domain_identifier: impl Display, ) -> Result<Vec<StoredAddress>>

Get addresses by domain object

GET /addresses/{domainType}/{domainIdentifier}

Returns stored meeting-place addresses for the group in the path. Only domainType=group is currently registered for this endpoint. Requires permission to view the group. The list is unpaginated, with no guaranteed order; meta.count is the number of addresses returned. An existing group without addresses returns an empty list.

§Example
for address in client.addresses().get("group", "42")? {
    println!("{:?}", address.name);
}

Search for addresses

GET /addresses/search

Searches for addresses across persons and a global geocoding service (e.g. Nominatim/Photon). Returns matching results from both sources. The query must be at least 2 characters long.

§Example
let query = GetAddressesSearchQuery {
    query: Some("Musterstraße".into()),
    ..Default::default()
};
for search in client.addresses().list_search(&query)? {
    println!("{:?}", search);
}
Source

pub fn update( &self, domain_type: impl Display, domain_identifier: impl Display, address_id: impl Display, body: &GroupAddressUpdate, ) -> Result<StoredAddress>

Update an address

PUT /addresses/{domainType}/{domainIdentifier}/{addressId}

Replaces a stored meeting-place address. Omitted body fields are cleared; send all values to retain. Only domainType=group is registered. Requires permission to edit the group’s meeting-place field (treffpunkt). Ownership and address ID are supplied in the path. Coordinates are accepted as numbers or decimal strings and returned as strings or null. The request does not geocode a postal address automatically.

§Example
let body = models::GroupAddressUpdate {
    name: Some(Some("Retreat Center".into())),
    ..Default::default()
};
let result = client.addresses().update("group", "42", 7, &body)?;
println!("{:?}", result.name);

Trait Implementations§

Source§

impl<'a> Clone for AddressesResource<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for AddressesResource<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for AddressesResource<'a>

§

impl<'a> !UnwindSafe for AddressesResource<'a>

§

impl<'a> Freeze for AddressesResource<'a>

§

impl<'a> Send for AddressesResource<'a>

§

impl<'a> Sync for AddressesResource<'a>

§

impl<'a> Unpin for AddressesResource<'a>

§

impl<'a> UnsafeUnpin for AddressesResource<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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