Class TSharedRef

library/cpp/yt/memory/ref.h:114–194

A reference to a range of memory with shared ownership.

//! A reference to a range of memory with shared ownership.
class TSharedRef
    : public TSharedRange<char>
{
public:
    //! Creates a null TSharedRef.
    TSharedRef() = default;

    //! Creates a TSharedRef with a given holder.
    TSharedRef(TRef ref, TSharedRangeHolderPtr holder);

    //! Creates a TSharedRef from a pointer and length.
    TSharedRef(const void* data, size_t length, TSharedRangeHolderPtr holder);

    //! Creates a TSharedRef from a range.
    TSharedRef(const void* begin, const void* end, TSharedRangeHolderPtr holder);

    //! Creates an empty TSharedRef.
    static TSharedRef MakeEmpty();

    //! Converts a TSharedRef to TRef.
    operator TRef() const;


    //! Creates a TSharedRef from TString.
    //! Since strings are ref-counted, no data is being copied.
    //! The memory is marked with a given tag.
    template <class TTag>
    static TSharedRef FromString(TString str);

    //! Same as above but the memory is marked with TDefaultSharedBlobTag.
    static TSharedRef FromString(TString str);

    //! Same as above but the memory tag is specified in #tagCookie.
    static TSharedRef FromString(TString str, TRefCountedTypeCookie tagCookie);

    //! Creates a TSharedRef from std::string.
    //! No data is being copied in #FromString itself but since #str is passed by value
    //! a copy may occur at caller's side.
    //! The memory is marked with a given tag.
    template <class TTag>
    static TSharedRef FromString(std::string str);

    //! Same as above but the memory is marked with TDefaultSharedBlobTag.
    static TSharedRef FromString(std::string str);

    //! Same as above but the memory tag is specified in #tagCookie.
    static TSharedRef FromString(std::string str, TRefCountedTypeCookie tagCookie);

    //! Creates a TSharedRef from a zero-terminated C string.
    static TSharedRef FromString(const char* str);

    //! Creates a TSharedRef for a given blob taking ownership of its content.
    static TSharedRef FromBlob(TBlob&& blob);

    //! Converts to TStringBuf.
    TStringBuf ToStringBuf() const;

    //! Creates a copy of a given TRef.