upipe/uuri.h header reference
Upipe functions to parse or generate URIs according to RFC3986 More
Header inclusion [link]
Members [link]
Types [link]
- struct uuri
- struct uuri_authority
Functions [link]
- bool uuri_authority_is_null(struct uuri_authority authority)
- int uuri_authority_len(const struct uuri_authority *authority, size_t *len_p)
- struct uuri_authority uuri_authority_null(void )
- int uuri_authority_to_buffer(const struct uuri_authority *authority, char *buffer, size_t len)
- ssize_t uuri_escape(const char *str, char *buffer, size_t size)
- ssize_t uuri_escape_len(const char *str)
- int uuri_from_str(struct uuri *uuri, const char *str)
- bool uuri_is_null(struct uuri uuri)
- int uuri_len(const struct uuri *uuri, size_t *len_p)
- struct uuri uuri_null(void )
- struct uuri uuri_parse(struct ustring *str)
- struct uuri_authority uuri_parse_authority(struct ustring *str)
- struct ustring uuri_parse_fragment(struct ustring *str)
- struct ustring uuri_parse_host(struct ustring *str)
- struct ustring uuri_parse_ipv4(struct ustring *str)
- struct ustring uuri_parse_ipv6(struct ustring *str)
- struct ustring uuri_parse_ipv6_scoped(struct ustring *str)
- struct ustring uuri_parse_ipvfuture(struct ustring *str)
- struct ustring uuri_parse_path(struct ustring *str)
- struct ustring uuri_parse_port(struct ustring *str)
- struct ustring uuri_parse_query(struct ustring *str)
- struct ustring uuri_parse_scheme(struct ustring *str)
- struct ustring uuri_parse_userinfo(struct ustring *str)
- bool uuri_query_get_param(struct ustring *str, struct ustring *name, struct ustring *value)
- int uuri_to_buffer(struct uuri *uuri, char *buffer, size_t len)
- int uuri_to_str(struct uuri *uuri, char **str_p)
- ssize_t uuri_unescape(const char *str, char *buffer, size_t size)
- ssize_t uuri_unescape_len(const char *str)
Description [link]
Upipe functions to parse or generate URIs according to RFC3986
Members detail [link]
#define _UPIPE_UURI_H_ [link]
This macro is declared in upipe/uuri.h source file, line 32.
struct uuri [link]
This struct is declared in upipe/uuri.h source file, line 238.
This struct stores the different parts of an URI.
scheme ':' [ '//' authority ] path [ '?' query ] [ '#' fragment ]
struct uuri_authority [link]
This struct is declared in upipe/uuri.h source file, line 176.
This struct stores the authority part of an URI.
[ userinfo '@' ] host [ ':' port ]
bool uuri_authority_is_null(struct uuri_authority authority) [link]
This function is declared in upipe/uuri.h source file, line 204.
This function checks if an authority is null.
Parameter list:
- authority: an uuri_authority structure
The return value is true if authority is null
int uuri_authority_len(const struct uuri_authority *authority, size_t *len_p) [link]
This function is declared in upipe/uuri.h source file, line 215.
This function gets the length required to print authority.
Parameter list:
- authority: pointer to an uuri_authority structure
- len_p: pointer to the length
The return value is an error code
struct uuri_authority uuri_authority_null(void ) [link]
This function is declared in upipe/uuri.h source file, line 190.
This function returns an initialized uuri_authority.
The return value is an initialized uuri_authority structure
int uuri_authority_to_buffer(const struct uuri_authority *authority, char *buffer, size_t len) [link]
This function is declared in upipe/uuri.h source file, line 225.
This function prints the authority into a buffer.
Parameter list:
- authority: pointer to an uuri_authority structure
- buffer: pointer to buffer
- len: size of the buffer
The return value is an error code
ssize_t uuri_escape(const char *str, char *buffer, size_t size) [link]
This function is declared in upipe/uuri.h source file, line 141.
This function escapes a string into a buffer.
Parameter list:
- str: the string to escape
- buffer: the destination buffer
- size: the size of the destination buffer
The return value is the size needed to escape or a negative value on error
ssize_t uuri_escape_len(const char *str) [link]
This function is declared in upipe/uuri.h source file, line 149.
This function returns the size needed to escape.
Parameter list:
- str: the string to escape
The return value is the size needed to escape or a negative value on error
This function is declared in upipe/uuri.h source file, line 315.
This function makes an uuri structure from a string.
Parameter list:
- uuri: pointer to an uuri structure
- str: the string to parse
The return value is an error code
This function is declared in upipe/uuri.h source file, line 272.
This function checks if an uri is null.
Parameter list:
- uuri: an uuri structure
The return value is true if uri is null
This function is declared in upipe/uuri.h source file, line 282.
This function gets the length required to print uri.
Parameter list:
- uuri: pointer to an uuri structure
- len_p: pointer to the length
The return value is an error code
This function is declared in upipe/uuri.h source file, line 256.
This function returns an initialized uuri.
The return value is an initialized uuri structure
This function is declared in upipe/uuri.h source file, line 306.
This function parses and shifts an uri.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an uuri structure with the uri portion of str
struct uuri_authority uuri_parse_authority(struct ustring *str) [link]
This function is declared in upipe/uuri.h source file, line 232.
This function parses and shifts an authority.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an authority structure with the authority portion of str
This function is declared in upipe/uuri.h source file, line 132.
This function parses and shifts a fragment.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an ustring with the fragment portion of str
This function is declared in upipe/uuri.h source file, line 86.
This function parses and shifts an authority host.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an ustring with the host portion of str
This function is declared in upipe/uuri.h source file, line 49.
This function parses an IPv4 and shifts ustring str. (ex: 192.168.0.1)
Parameter list:
- str: the ustring to parse
The return value is the parsed IPv4 or a null ustring
This function is declared in upipe/uuri.h source file, line 57.
This function parses an IPv6 and shifts ustring str. (ex: FE80:0000:0000:0000:0202:B3FF:FE1E:8329)
Parameter list:
- str: the ustring to parse
The return value is the parsed IPv6 or a null ustring
This function is declared in upipe/uuri.h source file, line 65.
This function parses a scoped IPv6 and shifts ustring str. (ex: FE80:0000:0000:0000:0202:B3FF:FE1E:8329%25eth0)
Parameter list:
- str: the ustring to parse
The return value is the parsed IPv6 or a null ustring
This function is declared in upipe/uuri.h source file, line 72.
This function parses a future ip and shifts ustring str.
Parameter list:
- str: the ustring to parse
The return value is the parsed IPv6 or a null ustring
This function is declared in upipe/uuri.h source file, line 107.
This function parses and shifts a path.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an ustring with the path portion of str
This function is declared in upipe/uuri.h source file, line 93.
This function parses and shifts an authority port.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an ustring with the port portion of str
This function is declared in upipe/uuri.h source file, line 114.
This function parses and shifts a query.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an ustring with the query portion of str
This function is declared in upipe/uuri.h source file, line 100.
This function parses and shifts a scheme.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an ustring with the scheme portion of str
This function is declared in upipe/uuri.h source file, line 79.
This function parses and shifts an authority user info.
Parameter list:
- str: pointer to an ustring to parse and shift
The return value is an ustring with the user info portion of str
This function is declared in upipe/uuri.h source file, line 125.
This function returns the first parameter of a query ustring and shift to the next.
Parameter list:
- str: pointer to an ustring containing a query
- name: filled with the parameter name
- value: filled with the parameter value
The return value is true if a parameter was parsed
This function is declared in upipe/uuri.h source file, line 291.
This function prints the uri into a buffer.
Parameter list:
- uuri: pointer to an uuri structure
- buffer: pointer to buffer
- len: size of the buffer
The return value is an error code
This function is declared in upipe/uuri.h source file, line 299.
This function allocates a string from an uri.
Parameter list:
- uuri: pointer to an uuri structure
- str_p: a pointer to the allocated string
The return value is an error code
ssize_t uuri_unescape(const char *str, char *buffer, size_t size) [link]
This function is declared in upipe/uuri.h source file, line 160.
This function unescapes a string into buffer.
Parameter list:
- str: the string to unescape
- buffer: the destination buffer
- size: the size of the destination buffer
The return value is the size needed to unescape or a negative value on error
ssize_t uuri_unescape_len(const char *str) [link]
This function is declared in upipe/uuri.h source file, line 168.
This function returns the size needed to unescape string.
Parameter list:
- str: the string to unescape
The return value is the size needed to unescape or a negative value on error