Files
rippled/src/ripple/basics/Slice.h
Josh Juran 7d75041fb1 Fixes to cryptographic containers:
* Include Sign.cpp in unity builds
* Fix AnySecretKey publicKey and sign
* Make AnyPublicKey copyable
* Define op != for Slice
* Overload op << for Slice
* Overload op << for KeyType
2015-05-27 13:25:20 -07:00

126 lines
3.2 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012, 2013 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#ifndef RIPPLE_BASICS_SLICE_H_INCLUDED
#define RIPPLE_BASICS_SLICE_H_INCLUDED
#include <ripple/basics/strHex.h>
#include <beast/utility/noexcept.h>
#include <algorithm>
#include <cassert>
#include <cstdint>
namespace ripple {
/** An immutable linear range of bytes.
A fully constructed Slice is guaranteed to be in a valid state.
Default construction, construction from nullptr, and zero-byte
ranges are disallowed. A Slice is lightweight and copyable, it
retains no ownership of the underlying memory.
*/
class Slice
{
private:
std::uint8_t const* data_;
std::size_t size_;
public:
// Disallowed
Slice() = delete;
Slice (Slice const&) = default;
Slice& operator= (Slice const&) = default;
/** Create a slice pointing to existing memory. */
Slice (void const* data, std::size_t size)
: data_ (reinterpret_cast<
std::uint8_t const*>(data))
, size_ (size)
{
assert(data_ != nullptr);
assert(size_ > 0);
}
/** Returns the number of bytes in the storage.
This will never be zero.
*/
std::size_t
size() const noexcept
{
return size_;
}
/** Return a pointer to beginning of the storage.
@note The return type is guaranteed to be a pointer
to a single byte, to facilitate pointer arithmetic.
*/
std::uint8_t const*
data() const noexcept
{
return data_;
}
};
template <class Hasher>
inline
void
hash_append (Hasher& h, Slice const& v)
{
h.append(v.data(), v.size());
}
inline
bool
operator== (Slice const& lhs, Slice const& rhs) noexcept
{
return lhs.size() == rhs.size() &&
std::memcmp(
lhs.data(), rhs.data(), lhs.size()) == 0;
}
inline
bool
operator!= (Slice const& lhs, Slice const& rhs) noexcept
{
return !(lhs == rhs);
}
inline
bool
operator< (Slice const& lhs, Slice const& rhs) noexcept
{
return std::lexicographical_compare(
lhs.data(), lhs.data() + lhs.size(),
rhs.data(), rhs.data() + rhs.size());
}
template <class Stream>
Stream& operator<<(Stream& s, Slice const& v)
{
s << strHex(v.data(), v.size());
return s;
}
} // ripple
#endif