1 #region Copyright notice and license 2 // Protocol Buffers - Google's data interchange format 3 // Copyright 2008 Google Inc. All rights reserved. 4 // https://developers.google.com/protocol-buffers/ 5 // 6 // Redistribution and use in source and binary forms, with or without 7 // modification, are permitted provided that the following conditions are 8 // met: 9 // 10 // * Redistributions of source code must retain the above copyright 11 // notice, this list of conditions and the following disclaimer. 12 // * Redistributions in binary form must reproduce the above 13 // copyright notice, this list of conditions and the following disclaimer 14 // in the documentation and/or other materials provided with the 15 // distribution. 16 // * Neither the name of Google Inc. nor the names of its 17 // contributors may be used to endorse or promote products derived from 18 // this software without specific prior written permission. 19 // 20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 #endregion 32 33 using System; 34 using System.Security; 35 36 namespace Google.Protobuf 37 { 38 /// <summary> 39 /// Provides a number of unsafe byte operations to be used by advanced applications with high performance 40 /// requirements. These methods are referred to as "unsafe" due to the fact that they potentially expose 41 /// the backing buffer of a <see cref="ByteString"/> to the application. 42 /// </summary> 43 /// <remarks> 44 /// <para> 45 /// The methods in this class should only be called if it is guaranteed that the buffer backing the 46 /// <see cref="ByteString"/> will never change! Mutation of a <see cref="ByteString"/> can lead to unexpected 47 /// and undesirable consequences in your application, and will likely be difficult to debug. Proceed with caution! 48 /// </para> 49 /// <para> 50 /// This can have a number of significant side affects that have spooky-action-at-a-distance-like behavior. In 51 /// particular, if the bytes value changes out from under a Protocol Buffer: 52 /// </para> 53 /// <list type="bullet"> 54 /// <item> 55 /// <description>serialization may throw</description> 56 /// </item> 57 /// <item> 58 /// <description>serialization may succeed but the wrong bytes may be written out</description> 59 /// </item> 60 /// <item> 61 /// <description>objects that are normally immutable (such as ByteString) are no longer immutable</description> 62 /// </item> 63 /// <item> 64 /// <description>hashCode may be incorrect</description> 65 /// </item> 66 /// </list> 67 /// </remarks> 68 [SecuritySafeCritical] 69 public static class UnsafeByteOperations 70 { 71 /// <summary> 72 /// Constructs a new <see cref="ByteString" /> from the given bytes. The bytes are not copied, 73 /// and must not be modified while the <see cref="ByteString" /> is in use. 74 /// This API is experimental and subject to change. 75 /// </summary> UnsafeWrap(ReadOnlyMemory<byte> bytes)76 public static ByteString UnsafeWrap(ReadOnlyMemory<byte> bytes) 77 { 78 return ByteString.AttachBytes(bytes); 79 } 80 } 81 } 82