url.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <promeki/namespace.h>
#include <promeki/string.h>
#include <promeki/stringlist.h>
#include <promeki/map.h>
#include <promeki/error.h>
#include <promeki/result.h>
#include <promeki/datatype.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class DataStream;
 
class Url {
        public:
                PROMEKI_DATATYPE(Url, DataTypeUrl, 1)
 
                
                Error writeToStream(DataStream &s) const;
                template <uint32_t V> static Result<Url> readFromStream(DataStream &s);
 
                static constexpr int PortUnset = -1;
 
                static Result<Url> fromString(const String &s);
 
                static String percentEncode(const String &s, const char *safe = nullptr);
 
                static String percentDecode(const String &s, Error *err = nullptr);
 
                Url() = default;
 
                explicit Url(const String &s) : Url(fromString(s).first()) {}
 
                explicit Url(const char *s) : Url(fromString(String(s)).first()) {}
 
                bool isValid() const { return !_scheme.isEmpty(); }
 
                const String &scheme() const { return _scheme; }
 
                const String &userInfo() const { return _userInfo; }
 
                const String &host() const { return _host; }
 
                int port() const { return _port; }
 
                const String &path() const { return _path; }
 
                const Map<String, String> &query() const { return _query; }
 
                String queryValue(const String &key, const String &defaultValue = String()) const {
                        return _query.value(key, defaultValue);
                }
 
                bool hasQueryValue(const String &key) const { return _query.contains(key); }
 
                const String &fragment() const { return _fragment; }
 
                bool hasAuthority() const { return _hasAuthority; }
 
                Url &setScheme(const String &s);
 
                Url &setUserInfo(const String &s) {
                        _userInfo = s;
                        return *this;
                }
 
                Url &setHost(const String &s);
 
                Url &setPort(int p) {
                        _port = p;
                        return *this;
                }
 
                Url &setPath(const String &s) {
                        _path = s;
                        return *this;
                }
 
                Url &setQuery(const Map<String, String> &q) {
                        _query = q;
                        _rawQuery.clear();
                        return *this;
                }
 
                Url &setQueryValue(const String &key, const String &value) {
                        _query.insert(key, value);
                        _rawQuery.clear();
                        return *this;
                }
 
                Url &removeQueryValue(const String &key) {
                        _query.remove(key);
                        _rawQuery.clear();
                        return *this;
                }
 
                const String &rawQuery() const { return _rawQuery; }
 
                Url &setRawQuery(const String &q) {
                        _rawQuery = q;
                        return *this;
                }
 
                Url &setFragment(const String &s) {
                        _fragment = s;
                        return *this;
                }
 
                Url &setHasAuthority(bool v) {
                        _hasAuthority = v;
                        return *this;
                }
 
                String toString() const;
 
                String redactedString() const;
 
                String briefForLog() const;
 
                bool operator==(const Url &other) const;
 
                bool operator!=(const Url &other) const { return !(*this == other); }
 
        private:
                String              _scheme;
                String              _userInfo;
                String              _host;
                int                 _port = PortUnset;
                String              _path;
                Map<String, String> _query;
                String              _rawQuery;
                String              _fragment;
                bool                _hasAuthority = false;
};
 
PROMEKI_NAMESPACE_END
 
PROMEKI_FORMAT_VIA_TOSTRING(promeki::Url);
 
#endif // PROMEKI_ENABLE_CORE