esphome::web_server::UrlMatch Struct Reference

Internal helper struct that is used to parse incoming URLs. More...

#include <web_server.h>

Public Member Functions
bool	domain_equals (const char *str) const
bool	id_equals_entity (EntityBase *entity) const
bool	method_equals (const char *str) const
bool	method_empty () const

Data Fields
const char *	domain
	Pointer to domain within URL, for example "sensor".
const char *	id
	Pointer to id within URL, for example "living_room_fan".
const char *	method
	Pointer to method within URL, for example "turn_on".
uint8_t	domain_len
	Length of domain string.
uint8_t	id_len
	Length of id string.
uint8_t	method_len
	Length of method string.
bool	valid
	Whether this match is valid.

Detailed Description

Internal helper struct that is used to parse incoming URLs.

Definition at line 37 of file web_server.h.

Member Function Documentation

domain_equals()

bool esphome::web_server::UrlMatch::domain_equals ( const char * str ) const

inline

Definition at line 47 of file web_server.h.

id_equals_entity()

bool esphome::web_server::UrlMatch::id_equals_entity ( EntityBase * entity ) const

inline

Definition at line 51 of file web_server.h.

method_empty()

bool esphome::web_server::UrlMatch::method_empty ( ) const

inline

Definition at line 66 of file web_server.h.

method_equals()

bool esphome::web_server::UrlMatch::method_equals ( const char * str ) const

inline

Definition at line 62 of file web_server.h.

Field Documentation

domain

const char* esphome::web_server::UrlMatch::domain

Pointer to domain within URL, for example "sensor".

Definition at line 38 of file web_server.h.

domain_len

uint8_t esphome::web_server::UrlMatch::domain_len

Length of domain string.

Definition at line 41 of file web_server.h.

id

const char* esphome::web_server::UrlMatch::id

Pointer to id within URL, for example "living_room_fan".

Definition at line 39 of file web_server.h.

id_len

uint8_t esphome::web_server::UrlMatch::id_len

Length of id string.

Definition at line 42 of file web_server.h.

method

const char* esphome::web_server::UrlMatch::method

Pointer to method within URL, for example "turn_on".

Definition at line 40 of file web_server.h.

method_len

uint8_t esphome::web_server::UrlMatch::method_len

Length of method string.

Definition at line 43 of file web_server.h.

valid

bool esphome::web_server::UrlMatch::valid

Whether this match is valid.

Definition at line 44 of file web_server.h.

---

The documentation for this struct was generated from the following file:

• esphome/components/web_server/web_server.h