Peak does not return next event

[BernieWhite]

Peak nomenclature and comment indicates that it should return the next event without consuming it.

Actual behaviour is to return the current event without consuming it.

YamlDotNet/YamlDotNet/Core/ParserExtensions.cs

Lines 87 to 99 in 2c6d522

	/// <summary>
	/// Gets the next event without consuming it.
	/// </summary>
	/// <typeparam name="T">Type of the <see cref="ParsingEvent"/>.</typeparam>
	/// <returns>Returns the current event if it is of type T; otherwise returns null.</returns>
	public static T Peek<T>(this IParser parser) where T : ParsingEvent
	{
	if (!parser.Accept<T>())
	{
	return null;
	}
	return (T)parser.Current;
	}

Accept indicates it checks the current event.

YamlDotNet/YamlDotNet/Core/ParserExtensions.cs

Lines 52 to 67 in 2c6d522

	/// <summary>
	/// Checks whether the current event is of the specified type.
	/// </summary>
	/// <typeparam name="T">Type of the event.</typeparam>
	/// <returns>Returns true if the current event is of type <typeparamref name="T"/>. Otherwise returns false.</returns>
	public static bool Accept<T>(this IParser parser) where T : ParsingEvent
	{
	if(parser.Current == null)
	{
	if (!parser.MoveNext())
	{
	throw new EndOfStreamException();
	}
	}
	return parser.Current is T;
	}

This is from master currently.

Really what I want to achieve is to check the next event so that I can determine a sequence, so that I can avoid consuming DocumentEnd unless it is followed by a DocumentStart event.

if (reader.Accept<DocumentEnd>())
{
    if (reader.Peek<DocumentStart>() != null)
    {
        reader.Allow<DocumentEnd>();
        reader.Allow<DocumentStart>();
    }
}

[aaubry]

I agree that the documentation is not very strict, but the behavior seems correct. It is not very clear what you are trying to achieve. It seems that you would want to peek on the next two events. I am correct ?