Add stat v2 and list v2 #133

Use unsafe to read bytes

Author: wherewhere

AdvancedSharpAdbClient.Tests/Dummys/DummySyncService.cs

@@ -25,17 +25,17 @@ public async Task OpenAsync(CancellationToken cancellationToken = default)
             IsOpen = true;
         }
 
-        public void Pull(string remotePath, Stream stream, Action<SyncProgressChangedEventArgs> callback = null, in bool isCancelled = false)
+        public void Pull(string remotePath, Stream stream, Action<SyncProgressChangedEventArgs> callback = null, bool useV2 = false, in bool isCancelled = false)
         {
-            for (int i = 0; i <= 100; i++)
+            for (uint i = 0; i <= 100; i++)
             {
                 callback?.Invoke(new SyncProgressChangedEventArgs(i, 100));
             }
         }
 
-        public async Task PullAsync(string remotePath, Stream stream, Action<SyncProgressChangedEventArgs> callback = null, CancellationToken cancellationToken = default)
+        public async Task PullAsync(string remotePath, Stream stream, Action<SyncProgressChangedEventArgs> callback = null, bool useV2 = false, CancellationToken cancellationToken = default)
         {
-            for (int i = 0; i <= 100; i++)
+            for (uint i = 0; i <= 100; i++)
             {
                 await Task.Yield();
                 callback?.Invoke(new SyncProgressChangedEventArgs(i, 100));
@@ -44,7 +44,7 @@ public async Task PullAsync(string remotePath, Stream stream, Action<SyncProgres
 
         public void Push(Stream stream, string remotePath, UnixFileStatus permission, DateTimeOffset timestamp, Action<SyncProgressChangedEventArgs> callback = null, in bool isCancelled = false)
         {
-            for (int i = 0; i <= 100; i++)
+            for (uint i = 0; i <= 100; i++)
             {
                 if (i == 100)
                 {
@@ -56,7 +56,7 @@ public void Push(Stream stream, string remotePath, UnixFileStatus permission, Da
 
         public async Task PushAsync(Stream stream, string remotePath, UnixFileStatus permission, DateTimeOffset timestamp, Action<SyncProgressChangedEventArgs> callback = null, CancellationToken cancellationToken = default)
         {
-            for (int i = 0; i <= 100; i++)
+            for (uint i = 0; i <= 100; i++)
             {
                 await Task.Yield();
                 if (i == 100)
@@ -79,14 +79,24 @@ public async Task ReopenAsync(CancellationToken cancellationToken = default)
 
         IAsyncEnumerable<FileStatistics> ISyncService.GetDirectoryAsyncListing(string remotePath, CancellationToken cancellationToken) => throw new NotImplementedException();
 
+        IAsyncEnumerable<FileStatisticsV2> ISyncService.GetDirectoryAsyncListingV2(string remotePath, CancellationToken cancellationToken) => throw new NotImplementedException();
+
         IEnumerable<FileStatistics> ISyncService.GetDirectoryListing(string remotePath) => throw new NotImplementedException();
 
         Task<List<FileStatistics>> ISyncService.GetDirectoryListingAsync(string remotePath, CancellationToken cancellationToken) => throw new NotImplementedException();
 
+        IEnumerable<FileStatisticsV2> ISyncService.GetDirectoryListingV2(string remotePath) => throw new NotImplementedException();
+
+        Task<List<FileStatisticsV2>> ISyncService.GetDirectoryListingV2Async(string remotePath, CancellationToken cancellationToken) => throw new NotImplementedException();
+
         FileStatistics ISyncService.Stat(string remotePath) => throw new NotImplementedException();
 
         Task<FileStatistics> ISyncService.StatAsync(string remotePath, CancellationToken cancellationToken) => throw new NotImplementedException();
 
+        FileStatisticsV2 ISyncService.StatV2(string remotePath) => throw new NotImplementedException();
+
+        Task<FileStatisticsV2> ISyncService.StatV2Async(string remotePath, CancellationToken cancellationToken) => throw new NotImplementedException();
+
         #endregion
     }
 }

AdvancedSharpAdbClient.Tests/SyncServiceTests.Async.cs

@@ -164,7 +164,7 @@ public async Task GetAsyncListingTest()
         }
 
         /// <summary>
-        /// Tests the <see cref="SyncService.PullAsync(string, Stream, Action{SyncProgressChangedEventArgs}?, CancellationToken)"/> method.
+        /// Tests the <see cref="SyncService.PullAsync(string, Stream, Action{SyncProgressChangedEventArgs}?, bool, CancellationToken)"/> method.
         /// </summary>
         [Fact]
         public async Task PullAsyncTest()

AdvancedSharpAdbClient.Tests/SyncServiceTests.cs

@@ -111,7 +111,7 @@ public void GetListingTest()
         }
 
         /// <summary>
-        /// Tests the <see cref="SyncService.Pull(string, Stream, Action{SyncProgressChangedEventArgs}?, in bool)"/> method.
+        /// Tests the <see cref="SyncService.Pull(string, Stream, Action{SyncProgressChangedEventArgs}?, bool, in bool)"/> method.
         /// </summary>
         [Fact]
         public void PullTest()

AdvancedSharpAdbClient/AdbSocket.Async.cs

@@ -221,7 +221,7 @@ public virtual async Task<string> ReadSyncStringAsync(CancellationToken cancella
             }
 
             // Get the length of the string
-            int len = reply[0] | (reply[1] << 8) | (reply[2] << 16) | (reply[3] << 24);
+            int len = BitConverter.ToInt32(reply);
 
             // And get the string
             reply = new byte[len];

AdvancedSharpAdbClient/AdbSocket.cs

@@ -305,7 +305,7 @@ public virtual string ReadSyncString()
             }
 
             // Get the length of the string
-            int len = reply[0] | (reply[1] << 8) | (reply[2] << 16) | (reply[3] << 24);
+            int len = BitConverter.ToInt32(reply);
 
             // And get the string
             reply = new byte[len];

AdvancedSharpAdbClient/AdvancedSharpAdbClient.csproj

@@ -10,6 +10,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
+    <AllowUnsafeBlocks>True</AllowUnsafeBlocks>
     <CheckNotRecommendedTargetFramework>False</CheckNotRecommendedTargetFramework>
     <NoWarn>$(NoWarn);NU1902;NU1903</NoWarn>
     <TargetFrameworks>net8.0;net10.0;netstandard1.3;netstandard2.0;netstandard2.1</TargetFrameworks>
@@ -38,7 +39,8 @@
       System.Range;
       System.Runtime.CompilerServices.CallerArgumentExpressionAttribute;
       System.Runtime.CompilerServices.IsExternalInit;
-      System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute
+      System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute;
+      System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute
     </PolySharpIncludeGeneratedTypes>
   </PropertyGroup>
 
@@ -51,7 +53,6 @@
   </PropertyGroup>
 
   <PropertyGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0-windows10.0.17763.0'))">
-    <AllowUnsafeBlocks>True</AllowUnsafeBlocks>
     <TargetPlatformMinVersion>10.0.10240.0</TargetPlatformMinVersion>
   </PropertyGroup>
 

AdvancedSharpAdbClient/DeviceCommands/DeviceExtensions.Async.cs

@@ -220,15 +220,18 @@ public static Task StopAppAsync(this IAdbClient client, DeviceData device, strin
         /// <param name="remotePath">The path, on the device, of the file to pull.</param>
         /// <param name="stream">A <see cref="Stream"/> that will receive the contents of the file.</param>
         /// <param name="callback">An optional parameter which, when specified, returns progress notifications. The progress is reported as a value between 0 and 100, representing the percentage of the file which has been transferred.</param>
+        /// <param name="useV2"><see langword="true"/> if use <see cref="ISyncService.Stat"/>; <see langword="true"/> use <see cref="ISyncService.StatV2"/>.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken"/> that can be used to cancel the task.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
+        /// <remarks>V2 need Android 8 or above.</remarks>
         public static async Task PullAsync(this IAdbClient client, DeviceData device,
             string remotePath, Stream stream,
             Action<SyncProgressChangedEventArgs>? callback = null,
+            bool useV2 = false,
             CancellationToken cancellationToken = default)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            await service.PullAsync(remotePath, stream, callback, cancellationToken).ConfigureAwait(false);
+            await service.PullAsync(remotePath, stream, callback, useV2, cancellationToken).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -404,15 +407,18 @@ public static Task InstallMultiplePackageAsync(this IAdbClient client, DeviceDat
         /// <param name="remotePath">The path, on the device, of the file to pull.</param>
         /// <param name="stream">A <see cref="Stream"/> that will receive the contents of the file.</param>
         /// <param name="progress">An optional parameter which, when specified, returns progress notifications. The progress is reported as a value between 0 and 100, representing the percentage of the file which has been transferred.</param>
+        /// <param name="useV2"><see langword="true"/> if use <see cref="ISyncService.Stat"/>; <see langword="true"/> use <see cref="ISyncService.StatV2"/>.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken"/> that can be used to cancel the task.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
+        /// <remarks>V2 need Android 8 or above.</remarks>
         public static async Task PullAsync(this IAdbClient client, DeviceData device,
             string remotePath, Stream stream,
             IProgress<SyncProgressChangedEventArgs>? progress,
+            bool useV2 = false,
             CancellationToken cancellationToken = default)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            await service.PullAsync(remotePath, stream, progress.AsAction(), cancellationToken).ConfigureAwait(false);
+            await service.PullAsync(remotePath, stream, progress.AsAction(), useV2, cancellationToken).ConfigureAwait(false);
         }
 
         /// <summary>

AdvancedSharpAdbClient/DeviceCommands/DeviceExtensions.cs

@@ -181,14 +181,17 @@ public static void StopApp(this IAdbClient client, DeviceData device, string pac
         /// <param name="remotePath">The path, on the device, of the file to pull.</param>
         /// <param name="stream">A <see cref="Stream"/> that will receive the contents of the file.</param>
         /// <param name="callback">An optional parameter which, when specified, returns progress notifications. The progress is reported as a value between 0 and 100, representing the percentage of the file which has been transferred.</param>
+        /// <param name="useV2"><see langword="true"/> if use <see cref="ISyncService.Stat"/>; <see langword="true"/> use <see cref="ISyncService.StatV2"/>.</param>
         /// <param name="isCancelled">A <see cref="bool"/> that can be used to cancel the task.</param>
+        /// <remarks>V2 need Android 8 or above.</remarks>
         public static void Pull(this IAdbClient client, DeviceData device,
             string remotePath, Stream stream,
             Action<SyncProgressChangedEventArgs>? callback = null,
+            bool useV2 = false,
             in bool isCancelled = false)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            service.Pull(remotePath, stream, callback, in isCancelled);
+            service.Pull(remotePath, stream, callback, useV2, in isCancelled);
         }
 
         /// <summary>
@@ -225,6 +228,20 @@ public static FileStatistics Stat(this IAdbClient client, DeviceData device, str
             return service.Stat(path);
         }
 
+        /// <summary>
+        /// Gets the file statistics of a given file (v2).
+        /// </summary>
+        /// <param name="client">The <see cref="IAdbClient"/> to use when executing the command.</param>
+        /// <param name="device">The device on which to look for the file.</param>
+        /// <param name="path">The path to the file.</param>
+        /// <returns>A <see cref="FileStatisticsV2"/> object that represents the file.</returns>
+        /// <remarks>Need Android 8 or above.</remarks>
+        public static FileStatisticsV2 StatV2(this IAdbClient client, DeviceData device, string path)
+        {
+            using ISyncService service = Factories.SyncServiceFactory(client, device);
+            return service.StatV2(path);
+        }
+
         /// <summary>
         /// Lists the contents of a directory on the device.
         /// </summary>
@@ -241,6 +258,23 @@ public static IEnumerable<FileStatistics> GetDirectoryListing(this IAdbClient cl
             }
         }
 
+        /// <summary>
+        /// Lists the contents of a directory on the device.
+        /// </summary>
+        /// <param name="client">The <see cref="IAdbClient"/> to use when executing the command.</param>
+        /// <param name="device">The device on which to list the directory.</param>
+        /// <param name="remotePath">The path to the directory on the device.</param>
+        /// <returns>For each child item of the directory, a <see cref="FileStatisticsV2"/> object with information of the item.</returns>
+        /// <remarks>Need Android 11 or above.</remarks>
+        public static IEnumerable<FileStatisticsV2> GetDirectoryListingV2(this IAdbClient client, DeviceData device, string remotePath)
+        {
+            using ISyncService service = Factories.SyncServiceFactory(client, device);
+            foreach (FileStatisticsV2 fileStatistics in service.GetDirectoryListingV2(remotePath))
+            {
+                yield return fileStatistics;
+            }
+        }
+
         /// <summary>
         /// Gets the property of a device.
         /// </summary>
@@ -337,14 +371,17 @@ public static void InstallMultiplePackage(this IAdbClient client, DeviceData dev
         /// <param name="remotePath">The path, on the device, of the file to pull.</param>
         /// <param name="stream">A <see cref="Stream"/> that will receive the contents of the file.</param>
         /// <param name="progress">An optional parameter which, when specified, returns progress notifications. The progress is reported as a value between 0 and 100, representing the percentage of the file which has been transferred.</param>
+        /// <param name="useV2"><see langword="true"/> if use <see cref="Stat"/>; <see langword="true"/> use <see cref="ISyncService.StatV2"/>.</param>
         /// <param name="isCancelled">A <see cref="bool"/> that can be used to cancel the task.</param>
+        /// <remarks>V2 need Android 8 or above.</remarks>
         public static void Pull(this IAdbClient client, DeviceData device,
             string remotePath, Stream stream,
             IProgress<SyncProgressChangedEventArgs>? progress = null,
+            bool useV2 = false,
             in bool isCancelled = false)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            service.Pull(remotePath, stream, progress.AsAction(), in isCancelled);
+            service.Pull(remotePath, stream, progress.AsAction(), useV2, in isCancelled);
         }
 
         /// <summary>

AdvancedSharpAdbClient/Extensions/EnumerableBuilder.cs

@@ -29,9 +29,14 @@ public static AdbCommandLineStatus AdbCommandLineStatusCreator(params ReadOnlySp
         /// </summary>
         /// <param name="values">The data that feeds the <see cref="ColorData"/> struct.</param>
         /// <returns>A new instance of <see cref="ColorData"/> struct.</returns>
-        public static ColorData ColorDataCreator(ReadOnlySpan<byte> values) =>
-            new((uint)(values[0] | (values[1] << 8) | (values[2] << 16) | (values[3] << 24)),
-                (uint)(values[4] | (values[5] << 8) | (values[6] << 16) | (values[7] << 24)));
+        public static unsafe ColorData ColorDataCreator(ReadOnlySpan<byte> values)
+        {
+            fixed (byte* p = values)
+            {
+                ColorData* data = (ColorData*)p;
+                return *data;
+            }
+        }
 
         /// <summary>
         /// Build a <see cref="FramebufferHeader"/> struct.
@@ -45,25 +50,49 @@ public static ColorData ColorDataCreator(ReadOnlySpan<byte> values) =>
         /// </summary>
         /// <param name="values">The data that feeds the <see cref="FileStatistics"/> struct.</param>
         /// <returns>A new instance of <see cref="FileStatistics"/> struct.</returns>
-        public static FileStatistics FileStatisticsCreator(ReadOnlySpan<byte> values)
+        public static FileStatistics FileStatisticsCreator(ReadOnlySpan<byte> values) => new(FileStatisticsDataCreator(values));
+
+        /// <summary>
+        /// Build a <see cref="FileStatisticsData"/> struct.
+        /// </summary>
+        /// <param name="values">The data that feeds the <see cref="FileStatisticsData"/> struct.</param>
+        /// <returns>A new instance of <see cref="FileStatisticsData"/> struct.</returns>
+        public static unsafe FileStatisticsData FileStatisticsDataCreator(ReadOnlySpan<byte> values)
         {
-            int index = 0;
-            return new FileStatistics
+            fixed (byte* p = values)
             {
-                FileMode = (UnixFileStatus)ReadUInt32(values),
-                Size = ReadUInt32(values),
-                Time = DateTimeOffset.FromUnixTimeSeconds(ReadUInt32(values))
-            };
-            uint ReadUInt32(in ReadOnlySpan<byte> data) => unchecked((uint)(data[index++] | (data[index++] << 8) | (data[index++] << 16) | (data[index++] << 24)));
+                FileStatisticsData* data = (FileStatisticsData*)p;
+                return *data;
+            }
+        }
+
+        /// <summary>
+        /// Build a <see cref="FileStatisticsV2"/> struct.
+        /// </summary>
+        /// <param name="values">The data that feeds the <see cref="FileStatisticsV2"/> struct.</param>
+        /// <returns>A new instance of <see cref="FileStatisticsV2"/> struct.</returns>
+        public static FileStatisticsV2 FileStatisticsV2Creator(ReadOnlySpan<byte> values) => new(FileStatisticsDataV2Creator(values));
+
+        /// <summary>
+        /// Build a <see cref="FileStatisticsDataV2"/> struct.
+        /// </summary>
+        /// <param name="values">The data that feeds the <see cref="FileStatisticsDataV2"/> struct.</param>
+        /// <returns>A new instance of <see cref="FileStatisticsDataV2"/> struct.</returns>
+        public static unsafe FileStatisticsDataV2 FileStatisticsDataV2Creator(ReadOnlySpan<byte> values)
+        {
+            fixed (byte* p = values)
+            {
+                FileStatisticsDataV2* data = (FileStatisticsDataV2*)p;
+                return *data;
+            }
         }
 
         /// <summary>
         /// Build a <see cref="UnixFileStatus"/> enum.
         /// </summary>
         /// <param name="values">The data that feeds the <see cref="UnixFileStatus"/> struct.</param>
         /// <returns>A new instance of <see cref="UnixFileStatus"/> struct.</returns>
-        public static UnixFileStatus UnixFileStatusCreator(ReadOnlySpan<byte> values) =>
-            (UnixFileStatus)(values[0] | (values[1] << 8) | (values[2] << 16) | (values[3] << 24));
+        public static unsafe UnixFileStatus UnixFileStatusCreator(ReadOnlySpan<byte> values) => (UnixFileStatus)BitConverter.ToUInt32(values);
 
         /// <summary>
         /// Build a <see cref="LogEntry"/> class.
@@ -276,19 +305,19 @@ static void ReadLogEntry(BinaryReader reader, params ICollection<object> parent)
             ushort? ReadUInt16(in ReadOnlySpan<byte> bytes)
             {
                 ReadOnlySpan<byte> data = ReadBytesSafe(bytes, 2);
-                return data.IsEmpty ? null : (ushort)(data[0] | (data[1] << 8));
+                return data.IsEmpty ? null : BitConverter.ToUInt16(data);
             }
 
             uint? ReadUInt32(in ReadOnlySpan<byte> bytes)
             {
                 ReadOnlySpan<byte> data = ReadBytesSafe(bytes, 4);
-                return data.IsEmpty ? null : (uint)(data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24));
+                return data.IsEmpty ? null : BitConverter.ToUInt32(data);
             }
 
             int? ReadInt32(in ReadOnlySpan<byte> bytes)
             {
                 ReadOnlySpan<byte> data = ReadBytesSafe(bytes, 4);
-                return data.Length != 4 ? null : data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24);
+                return data.Length != 4 ? null : BitConverter.ToInt32(data);
             }
 
             ReadOnlySpan<byte> ReadBytesSafe(in ReadOnlySpan<byte> bytes, int count)