IterableToInputStream.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_Streams_IterableToInputStream_h_
#define _Stroika_Foundation_Streams_IterableToInputStream_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/Streams/InputStream.h"
#include "Stroika/Foundation/Traversal/Iterable.h"
 
/**
 *  \file
 *
 *  \note Code-Status:  <a href="Code-Status.md#Beta">Beta</a>
 *
 */
 
namespace Stroika::Foundation::Streams::IterableToInputStream {
 
    using InputStream::Ptr;
 
    /**
     *  Sometimes, convenient to take an object which is Iterable, and treat it as an InputStream<> (similar but not identical concepts).
     * 
     *  For example, this can be used to treat a String as an InputStream<Character>.
     * 
     *  \par Example Usage
     *      \code
     *          InputStream::Ptr<Character> in = IterableToInputStream::New<Character> (String{"hi"});
     *      \endcode
     */
    template <typename ELEMENT_TYPE>
    auto New (const Traversal::Iterable<ELEMENT_TYPE>& it) -> Ptr<ELEMENT_TYPE>;
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "IterableToInputStream.inl"
 
#endif /*_Stroika_Foundation_Streams_IterableToInputStream_h_*/