ce5636eb29
This adds both the core Rust implementation and the code to enable the needed language bindings. This additionally enables GIFFT on the URL type, mirroring them to a string scalar. Differential Revision: https://phabricator.services.mozilla.com/D145215
71 lines
1.8 KiB
C++
71 lines
1.8 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_glean_GleanUrl_h
|
|
#define mozilla_glean_GleanUrl_h
|
|
|
|
#include "mozilla/Maybe.h"
|
|
#include "mozilla/Result.h"
|
|
#include "nsIGleanMetrics.h"
|
|
#include "nsString.h"
|
|
|
|
namespace mozilla::glean {
|
|
|
|
namespace impl {
|
|
|
|
class UrlMetric {
|
|
public:
|
|
constexpr explicit UrlMetric(uint32_t aId) : mId(aId) {}
|
|
|
|
/*
|
|
* Set to the specified value.
|
|
*
|
|
* @param aValue The stringified Url to set the metric to.
|
|
*/
|
|
void Set(const nsACString& aValue) const;
|
|
|
|
/**
|
|
* **Test-only API**
|
|
*
|
|
* Gets the currently stored value as a string.
|
|
*
|
|
* This function will attempt to await the last parent-process task (if any)
|
|
* writing to the the metric's storage engine before returning a value.
|
|
* This function will not wait for data from child processes.
|
|
*
|
|
* This doesn't clear the stored value.
|
|
* Parent process only. Panics in child processes.
|
|
*
|
|
* @param aPingName The (optional) name of the ping to retrieve the metric
|
|
* for. Defaults to the first value in `send_in_pings`.
|
|
*
|
|
* @return value of the stored metric, or Nothing() if there is no value.
|
|
*/
|
|
Result<Maybe<nsCString>, nsCString> TestGetValue(
|
|
const nsACString& aPingName = nsCString()) const;
|
|
|
|
private:
|
|
const uint32_t mId;
|
|
};
|
|
} // namespace impl
|
|
|
|
class GleanUrl final : public nsIGleanUrl {
|
|
public:
|
|
NS_DECL_ISUPPORTS
|
|
NS_DECL_NSIGLEANURL
|
|
|
|
explicit GleanUrl(uint32_t aId) : mUrl(aId){};
|
|
|
|
private:
|
|
virtual ~GleanUrl() = default;
|
|
|
|
const impl::UrlMetric mUrl;
|
|
};
|
|
|
|
} // namespace mozilla::glean
|
|
|
|
#endif /* mozilla_glean_GleanUrl_h */
|