readablestream.go

// SPDX-FileCopyrightText: 2026 The Pion community <https://pion.ly>
// SPDX-License-Identifier: MIT

package quic

import (
	"time"

	"github.com/pion/quic/internal/wrapper"
	quic "github.com/quic-go/quic-go"
)

// StreamID is the ID of a quic stream.
type StreamID int64

// ReadableStream represents a unidirectional quic ReceiveStream.
type ReadableStream struct {
	s *wrapper.ReadableStream
}

// ReadInto reads from the ReadableStream into the buffer.
func (s *ReadableStream) ReadInto(data []byte) (StreamReadResult, error) {
	n, fin, err := s.s.ReadQuic(data)

	return StreamReadResult{
		Amount:   n,
		Finished: fin,
	}, err
}

// StreamID returns the ID of the ReadableStream.
func (s *ReadableStream) StreamID() StreamID {
	return StreamID(s.s.StreamID())
}

// SetReadDeadline sets the deadline for future Read calls. A zero value for t means Read will not time out.
func (s *ReadableStream) SetReadDeadline(t time.Time) error {
	return s.s.SetReadDeadline(t)
}

// Detach detaches and returns the underlying quic-go ReceiveStream.
func (s *ReadableStream) Detach() *quic.ReceiveStream {
	return s.s.Detach()
}