Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions PowerKit.Tests/StreamPortalTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
using System.IO;
using FluentAssertions;
using PowerKit.Extensions;
using Xunit;

namespace PowerKit.Tests;

public class StreamPortalTests
{
[Fact]
public void CreatePortal_AtCurrentPosition_Test()
{
// Arrange
var data = new byte[] { 1, 2, 3, 4, 5 };
using var stream = new MemoryStream(data);
stream.Seek(2, SeekOrigin.Begin);

// Act
var portal = stream.CreatePortal();

// Assert
portal.Position.Should().Be(2);
}

[Fact]
public void CreatePortal_AtSpecifiedPosition_Test()
{
// Arrange
var data = new byte[] { 1, 2, 3, 4, 5 };
using var stream = new MemoryStream(data);

// Act
var portal = stream.CreatePortal(3);

// Assert
portal.Position.Should().Be(3);
}

[Fact]
public void Jump_SeeksToPortalPositionAndRestoresOnDispose_Test()
{
// Arrange
var data = new byte[] { 1, 2, 3, 4, 5 };
using var stream = new MemoryStream(data);
stream.Seek(1, SeekOrigin.Begin);
var portal = stream.CreatePortal(4);

// Act
var jump = portal.Jump();

// Assert - seeks to portal position
stream.Position.Should().Be(4);

jump.Dispose();

// Assert - restores original position on dispose
stream.Position.Should().Be(1);
}
}
10 changes: 10 additions & 0 deletions PowerKit/Extensions/StreamExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ public static class StreamExtensions
{
extension(Stream source)
{
/// <summary>
/// Creates a portal to the specified position in the stream.
/// </summary>
public StreamPortal CreatePortal(long position) => new(source, position);

/// <summary>
/// Creates a portal to the current position in the stream.
/// </summary>
public StreamPortal CreatePortal() => source.CreatePortal(source.Position);
Comment thread
Tyrrrz marked this conversation as resolved.

#if NET40_OR_GREATER || NETSTANDARD || NET
/// <summary>
/// Copies the contents of the stream to the destination stream, optionally flushing after each write.
Expand Down
35 changes: 35 additions & 0 deletions PowerKit/StreamPortal.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
using System;
using System.IO;

namespace PowerKit;

/// <summary>
/// Represents a saved position in a stream that can be jumped to and returned from.
/// </summary>
public class StreamPortal(Stream stream, long position)
{
/// <summary>
/// Gets the position this portal points to.
/// </summary>
public long Position { get; } =
stream.CanSeek
? position >= 0
? position
: throw new ArgumentOutOfRangeException(
nameof(position),
"Position must be non-negative."
)
: throw new ArgumentException("Stream must support seeking.", nameof(stream));

/// <summary>
/// Seeks the stream to the portal's position and returns a disposable that,
/// when disposed, seeks back to the original position.
/// </summary>
public IDisposable Jump()
{
var oldPosition = stream.Position;
stream.Seek(Position, SeekOrigin.Begin);

return Disposable.Create(() => stream.Seek(oldPosition, SeekOrigin.Begin));
}
}