#region Copyright notice and license
// Protocol Buffers - Google's data interchange format
// Copyright 2015 Google Inc. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd
#endregion
using Google.Protobuf.Reflection;
namespace Google.Protobuf.WellKnownTypes
{
public partial class Any
{
private const string DefaultPrefix = "type.googleapis.com";
// This could be moved to MessageDescriptor if we wanted to, but keeping it here means
// all the Any-specific code is in the same place.
private static string GetTypeUrl(MessageDescriptor descriptor, string prefix) =>
prefix.EndsWith("/") ? prefix + descriptor.FullName : prefix + "/" + descriptor.FullName;
///
/// Retrieves the type name for a type URL, matching the
/// of the packed message type.
///
///
///
/// This is always just the last part of the URL, after the final slash. No validation of
/// anything before the trailing slash is performed. If the type URL does not include a slash,
/// an empty string is returned rather than an exception being thrown; this won't match any types,
/// and the calling code is probably in a better position to give a meaningful error.
///
///
/// There is no handling of fragments or queries at the moment.
///
///
/// The URL to extract the type name from
/// The type name
public static string GetTypeName(string typeUrl)
{
ProtoPreconditions.CheckNotNull(typeUrl, nameof(typeUrl));
int lastSlash = typeUrl.LastIndexOf('/');
return lastSlash == -1 ? "" : typeUrl.Substring(lastSlash + 1);
}
///
/// Returns a bool indictating whether this Any message is of the target message type
///
/// The descriptor of the message type
/// true if the type name matches the descriptor's full name or false otherwise
public bool Is(MessageDescriptor descriptor)
{
ProtoPreconditions.CheckNotNull(descriptor, nameof(descriptor));
return GetTypeName(TypeUrl) == descriptor.FullName;
}
///
/// Unpacks the content of this Any message into the target message type,
/// which must match the type URL within this Any message.
///
/// The type of message to unpack the content into.
/// The unpacked message.
/// The target message type doesn't match the type URL in this message
public T Unpack() where T : IMessage, new()
{
// Note: this doesn't perform as well is it might. We could take a MessageParser in an alternative overload,
// which would be expected to perform slightly better... although the difference is likely to be negligible.
T target = new T();
if (GetTypeName(TypeUrl) != target.Descriptor.FullName)
{
throw new InvalidProtocolBufferException(
$"Full type name for {target.Descriptor.Name} is {target.Descriptor.FullName}; Any message's type url is {TypeUrl}");
}
target.MergeFrom(Value);
return target;
}
///
/// Attempts to unpack the content of this Any message into the target message type,
/// if it matches the type URL within this Any message.
///
/// The type of message to attempt to unpack the content into.
/// true if the message was successfully unpacked; false if the type name didn't match
public bool TryUnpack(out T result) where T : IMessage, new()
{
// Note: deliberately avoid writing anything to result until the end, in case it's being
// monitored by other threads. (That would be a bug in the calling code, but let's not make it worse.)
T target = new T();
if (GetTypeName(TypeUrl) != target.Descriptor.FullName)
{
result = default; // Can't use null as there's no class constraint, but this always *will* be null in real usage.
return false;
}
target.MergeFrom(Value);
result = target;
return true;
}
///
/// Attempts to unpack the content of this Any message into one of the message types
/// in the given type registry, based on the type URL.
///
/// The type registry to consult for messages.
/// The unpacked message, or null if no matching message was found.
public IMessage Unpack(TypeRegistry registry)
{
string typeName = GetTypeName(TypeUrl);
MessageDescriptor descriptor = registry.Find(typeName);
if (descriptor == null)
{
return null;
}
var message = descriptor.Parser.CreateTemplate();
message.MergeFrom(Value);
return message;
}
///
/// Packs the specified message into an Any message using a type URL prefix of "type.googleapis.com".
///
/// The message to pack.
/// An Any message with the content and type URL of .
public static Any Pack(IMessage message) => Pack(message, DefaultPrefix);
///
/// Packs the specified message into an Any message using the specified type URL prefix.
///
/// The message to pack.
/// The prefix for the type URL.
/// An Any message with the content and type URL of .
public static Any Pack(IMessage message, string typeUrlPrefix)
{
ProtoPreconditions.CheckNotNull(message, nameof(message));
ProtoPreconditions.CheckNotNull(typeUrlPrefix, nameof(typeUrlPrefix));
return new Any
{
TypeUrl = GetTypeUrl(message.Descriptor, typeUrlPrefix),
Value = message.ToByteString()
};
}
}
}