/// <summary>
/// Downloads remote file as string.
/// </summary>
/// <param name="client">The Kudu client.</param>
/// <param name="remotePath">The remote source path.</param>
/// <param name="encoding">The text encoding.</param>
/// <returns>Content as string.</returns>
/// <example>
/// <code>
/// #addin nuget:?package=Cake.Kudu.Client
///
/// string baseUri = EnvironmentVariable("KUDU_CLIENT_BASEURI"),
/// userName = EnvironmentVariable("KUDU_CLIENT_USERNAME"),
/// password = EnvironmentVariable("KUDU_CLIENT_PASSWORD");
///
/// IKuduClient kuduClient = KuduClient(
/// baseUri,
/// userName,
/// password);
///
/// FilePath remoteFilePath = "/site/wwwroot/hello.txt";
///
/// string resultString = kuduClient.VFSDownloadString(remoteFilePath);
///
/// Information("Result: {0}", resultString);
/// </code>
/// </example>
// ReSharper disable once InconsistentNaming
public static string VFSDownloadString(
this IKuduClient client,
FilePath remotePath,
Encoding encoding = null)
{
using (var reader = new StreamReader(client.VFSDownloadStream(remotePath), encoding ?? Encoding.UTF8))
{
return(reader.ReadToEnd());
}
}
